mirror of
https://github.com/crate-ci/typos.git
synced 2024-11-24 10:00:59 -05:00
docs: Reformat README
This commit is contained in:
parent
4f85e39e09
commit
16e7bd26e7
2 changed files with 11 additions and 14 deletions
17
README.md
17
README.md
|
@ -8,15 +8,11 @@
|
||||||
![License](https://img.shields.io/crates/l/defenestrate.svg)
|
![License](https://img.shields.io/crates/l/defenestrate.svg)
|
||||||
[![Crates Status](https://img.shields.io/crates/v/defenestrate.svg)](https://crates.io/crates/defenestrate)
|
[![Crates Status](https://img.shields.io/crates/v/defenestrate.svg)](https://crates.io/crates/defenestrate)
|
||||||
|
|
||||||
|
## [Install](docs/install.md)
|
||||||
|
|
||||||
## [About](docs/about.md)
|
## [About](docs/about.md)
|
||||||
|
|
||||||
## Install
|
## [Contribute](CONTRIBUTING.md)
|
||||||
|
|
||||||
For now, `rust` is required for install:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cargo install defenestrate
|
|
||||||
```
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
@ -27,12 +23,5 @@ Licensed under either of
|
||||||
|
|
||||||
at your option.
|
at your option.
|
||||||
|
|
||||||
### Contribution
|
|
||||||
|
|
||||||
Unless you explicitly state otherwise, any contribution intentionally
|
|
||||||
submitted for inclusion in the work by you, as defined in the Apache-2.0
|
|
||||||
license, shall be dual licensed as above, without any additional terms or
|
|
||||||
conditions.
|
|
||||||
|
|
||||||
[Crates.io]: https://crates.io/crates/defenestrate
|
[Crates.io]: https://crates.io/crates/defenestrate
|
||||||
[Documentation]: https://docs.rs/defenestrate
|
[Documentation]: https://docs.rs/defenestrate
|
||||||
|
|
8
docs/install.md
Normal file
8
docs/install.md
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
# Install
|
||||||
|
|
||||||
|
For now, `rust` is required for install:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo install defenestrate
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue