Create README.md

valentinegb · Apr 1, 2024 · 7b72a16 · 7b72a16
1 parent 1d03275
commit 7b72a16
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# `demangle`
+
+[![Rust](https://github.com/valentinegb/demangle/actions/workflows/rust.yml/badge.svg)](https://github.com/valentinegb/demangle/actions/workflows/rust.yml)
+
+CLI tool for quickly demangling a symbol
+
+## Usage
+
+```txt
+demangle <LANGUAGE> <SYMBOL>
+```
+
+Use `demangle --help` for more.
+
+## Installation
+
+```sh
+cargo install demangle
+```