branch: elpa/flamegraph
commit 561efdc1b53507403d4f106c84833c6feae599f3
Author: Dmitry Gutov <[email protected]>
Commit: Dmitry Gutov <[email protected]>
Add NonGNU ELPA install instructions and badges
---
README.md | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 24cd09d708..9735b8532a 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
# flamegraph.el
[](https://github.com/dgutov/emacs-flamegraph/actions/workflows/ci.yml)
+[](https://elpa.nongnu.org/nongnu/flamegraph.html)
+[](https://elpa.nongnu.org/nongnu-devel/flamegraph.html)
[Flame graphs][bg] for the Emacs profiler, and for folded-stacks
files produced by `perf`, `py-spy`, `rbspy`, etc.
@@ -38,14 +40,14 @@ highlighting, and keep the Calls list flat.
## Installation
-Until this lands on a package archive, clone the repo and add it to
-your `load-path`:
+Available from [NonGNU ELPA][nongnu], which is enabled by default in
+Emacs 28+:
-```elisp
-(add-to-list 'load-path "/path/to/emacs-flamegraph")
-(autoload 'flamegraph-profiler-report "flamegraph" nil t)
-(autoload 'flamegraph-find-profile "flamegraph" nil t)
```
+M-x package-install RET flamegraph RET
+```
+
+[nongnu]: https://elpa.nongnu.org/nongnu/flamegraph.html
Requires Emacs 30.1+.