Skip to content

Commit b84ec3c

Browse files
authored
fix: add doc usage update (#15)
1 parent ccacc8c commit b84ec3c

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,20 @@
99

1010
> Project template for a Rust library.
1111
12-
## Usage
12+
## Project Template Usage
1313

1414
1. Use as a
1515
[template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template)
1616
to create a new repository.
1717
2. Update links and references in `README.md`.
1818

19+
## Cargo Crate Usage
20+
21+
```toml
22+
[dependencies]
23+
flowscripter_template_rust_library = "^1"
24+
```
25+
1926
## Development
2027

2128
Build: `cargo build`
@@ -30,7 +37,7 @@ Lint: `cargo fmt`
3037

3138
PNG image generated from `images/uml_diagram.mermaid`:
3239

33-
![UML Diagram](images/uml_diagram.png "UML Diagram")
40+
![UML Diagram](https://raw.githubusercontent.com/flowscripter/template-rust-library/main/images/uml_diagram.png "UML Diagram")
3441

3542
### API
3643

0 commit comments

Comments
 (0)