Skip to content

Commit 5ff331e

Browse files
committed
Add usage and license sections to README
1 parent 3bae00b commit 5ff331e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,31 @@ It is Implemented on top of [petgraph](https://github.com/bluss/petulant-avenger
88

99
[Documentation](http://mitchmindtree.github.io/rose_tree-rs/rose_tree)
1010
---------------
11+
12+
Usage
13+
-----
14+
15+
Please see the [tests directory](https://github.com/mitchmindtree/rose_tree-rs/tree/master/tests) for some basic usage examples.
16+
17+
Use rose_tree in your project by adding it to your Cargo.toml dependencies like so:
18+
19+
```toml
20+
[dependencies]
21+
rose_tree = "*"
22+
```
23+
24+
and then adding
25+
26+
```rust
27+
extern crate rose_tree;
28+
```
29+
30+
to your lib.rs.
31+
32+
33+
License
34+
-------
35+
36+
Dual-licensed to be compatible with the petgraph and Rust projects.
37+
38+
Licensed under the Apache License, Version 2.0 http://www.apache.org/licenses/LICENSE-2.0 or the MIT license http://opensource.org/licenses/MIT, at your option. This file may not be copied, modified, or distributed except according to those terms.

0 commit comments

Comments
 (0)