diff --git a/README.md b/README.md index dc8b2b6..477167b 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,16 @@ A Proof-of-concept low-overhead sampling CPU profiler written in Rust for Python implemented using eBPF. It is heavily "influenced" by [rbperf](https://github.com/javierhonduco/rbperf) and [py-spy](https://github.com/benfred/py-spy). +> [!DANGER] > IT IS NOT READY FOR PRODUCTION USE AND IT IS NOT INTENDED TO BE A REPLACEMENT FOR EXISTING TOOLS. +> It is still considered experimental. Please feel free to contribute or provide feedback! + +> [!WARNING] > If you are looking for a production-ready tool, please check out [parca-agent](https://github.com/parca-dev/parca-agent) instead. +> [!NOTE] +> If you are curious how this tool works under the hood, check out the [blog post](https://www.polarsignals.com/blog/posts/2023/10/04/profiling-python-and-ruby-with-ebpf)! + ## Features The main goals for `py-perf` are: