aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
index 8c7b8d3..6dd9667 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -48,6 +48,18 @@
## Quick Start
+> To use a release version of `Mingling`, get the latest version from [`crates.io`](https://crates.io/crates/mingling)
+>
+> To use the latest version, pull the project from the `main` branch on `github`
+
+```toml
+# From crates.io
+mingling = "0.1.6"
+
+# From GitHub
+mingling = { git = "https://github.com/catilgrass/mingling", branch = "main" }
+```
+
The example below shows how to use `Mingling` to create a simple command-line program:
```rust