doc: add documentation section
This commit is contained in:
parent
43af123801
commit
ed5d7be035
1 changed files with 8 additions and 2 deletions
10
README.md
10
README.md
|
@ -12,11 +12,17 @@ estring = "0.1"
|
||||||
|
|
||||||
A simple way to parse a string using type annotations.
|
A simple way to parse a string using type annotations.
|
||||||
|
|
||||||
This package was originally designed for [enve]
|
This package was originally designed for [enve].
|
||||||
|
|
||||||
[enve]: https://github.com/pleshevskiy/enve
|
[enve]: https://github.com/pleshevskiy/enve
|
||||||
|
|
||||||
## Getting started
|
## [Documentation](https://docs.rs/estring)
|
||||||
|
|
||||||
|
For more details, see [examples].
|
||||||
|
|
||||||
|
[examples]: https://github.com/pleshevskiy/estring/tree/main/examples
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
```rust
|
```rust
|
||||||
use estring::{SepVec, EString};
|
use estring::{SepVec, EString};
|
||||||
|
|
Reference in a new issue