aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-04-22 16:49:28 +0800
committer魏曹先生 <1992414357@qq.com>2026-04-22 16:49:28 +0800
commit67e949309771019e86ab5c83691edc7afff7e6be (patch)
tree3655d4f8ec09beed36497be5becc4dceac6cc44d /docs
parent3785202ec5b949cba5501b20729b16f4c29ea626 (diff)
Add workspace configuration and update dependencies
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md12
-rw-r--r--docs/res/guide.txt2
2 files changed, 13 insertions, 1 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
diff --git a/docs/res/guide.txt b/docs/res/guide.txt
index 89c6d8b..a75037f 100644
--- a/docs/res/guide.txt
+++ b/docs/res/guide.txt
@@ -7,6 +7,6 @@
│ > cargo add mingling │
│ │
│ Or add this to your Cargo.toml │
- │ > mingling = "0.1.6" │
+ │ > mingling = "0.1.7" │
│ │
└────────────────────────────────────┘