crates.io info

agourlay · Mar 19, 2024 · 853c37b · 853c37b
1 parent 146527d
commit 853c37b
Showing 1 changed file with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # hprof-slurp
-[![Build](https://github.com/agourlay/hprof-slurp/actions/workflows/ci.yml/badge.svg)](https://github.com/agourlay/hprof-slurp/actions/workflows/ci.yml)
+
+[![Build status](https://github.com/agourlay/hprof-slurp/actions/workflows/ci.yml/badge.svg)](https://github.com/agourlay/hprof-slurp/actions/workflows/ci.yml)
+[![Crates.io](https://img.shields.io/crates/v/hprof-slurp.svg)](https://crates.io/crates/hprof-slurp)
 
 `hprof-slurp` is a specialized JVM heap dump analyzer.
 
@@ -77,6 +79,20 @@ Total size | Instances |     Largest | Class name
    3.13KiB |        56 | 144.00bytes | java.lang.String[]
 ```
 
+## Installation
+
+### Releases
+
+Using the provided binaries in https://github.com/agourlay/hprof-slurp/releases
+
+### Crates.io
+
+Using Cargo via [crates.io](https://crates.io/crates/hprof-slurp).
+
+```bash
+cargo install hprof-slurp
+```
+
 ## Performance
 
 On modern hardware `hprof-slurp` can process heap dump files at around 1GB/s.