Skip to content

Commit 1428d37

Browse files
epageepage
committed
docs: Fill out READMEs
1 parent e4720a3 commit 1428d37

File tree

4 files changed

+95
-6
lines changed

4 files changed

+95
-6
lines changed

‎README.md‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
1-
# argfile
1+
# anstyle
22

3-
> Load additional CLI args from file
3+
> ANSI text styling
44
55
[![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]
6-
![License](https://img.shields.io/crates/l/argfile.svg)
7-
[![Crates Status](https://img.shields.io/crates/v/argfile.svg)](https://crates.io/crates/argfile)
6+
![License](https://img.shields.io/crates/l/anstyle.svg)
7+
[![Crates Status](https://img.shields.io/crates/v/anstyle.svg)](https://crates.io/crates/anstyle)
8+
9+
`anstyle` provides core types describing [ANSI styling escape
10+
codes](https://en.wikipedia.org/wiki/ANSI_escape_code) for interoperability
11+
between crates. For example, this would allow a crate to provide an API for
12+
customizing the colors used without putting the underlying text styling crate
13+
in the API.
14+
15+
For integration with your text styling crate, see:
16+
- [anstyle-termcolor](crates/termcolor)
17+
- [anstyle-owo-colors](crates/owo)
18+
- [anstyle-yansi](crates/yansi)
819

920
## License
1021

@@ -22,5 +33,5 @@ submitted for inclusion in the work by you, as defined in the Apache-2.0
2233
license, shall be dual licensed as above, without any additional terms or
2334
conditions.
2435

25-
[Crates.io]: https://crates.io/crates/argfile
26-
[Documentation]: https://docs.rs/argfile
36+
[Crates.io]: https://crates.io/crates/anstyle
37+
[Documentation]: https://docs.rs/anstyle

‎crates/owo/README.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# anstyle-owo-colors
2+
3+
> Convert from color styling types to [owo-colors](https:://lib.rs/owo-colors) color types
4+
5+
[![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]
6+
![License](https://img.shields.io/crates/l/anstyle-owo-colors.svg)
7+
[![Crates Status](https://img.shields.io/crates/v/anstyle-owo-colors.svg)](https://crates.io/crates/anstyle-owo-colors)
8+
9+
## License
10+
11+
Licensed under either of
12+
13+
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
14+
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
15+
16+
at your option.
17+
18+
### Contribution
19+
20+
Unless you explicitly state otherwise, any contribution intentionally
21+
submitted for inclusion in the work by you, as defined in the Apache-2.0
22+
license, shall be dual licensed as above, without any additional terms or
23+
conditions.
24+
25+
[Crates.io]: https://crates.io/crates/anstyle-owo-colors
26+
[Documentation]: https://docs.rs/anstyle-owo-colors

‎crates/termcolor/README.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# anstyle-termcolor
2+
3+
> Convert from color styling types to [termcolor](https:://lib.rs/termcolor) color types
4+
5+
[![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]
6+
![License](https://img.shields.io/crates/l/anstyle-termcolor.svg)
7+
[![Crates Status](https://img.shields.io/crates/v/anstyle-termcolor.svg)](https://crates.io/crates/anstyle-termcolor)
8+
9+
## License
10+
11+
Licensed under either of
12+
13+
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
14+
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
15+
16+
at your option.
17+
18+
### Contribution
19+
20+
Unless you explicitly state otherwise, any contribution intentionally
21+
submitted for inclusion in the work by you, as defined in the Apache-2.0
22+
license, shall be dual licensed as above, without any additional terms or
23+
conditions.
24+
25+
[Crates.io]: https://crates.io/crates/anstyle-termcolor
26+
[Documentation]: https://docs.rs/anstyle-termcolor

‎crates/yansi/README.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# anstyle-yansi
2+
3+
> Convert from color styling types to [yansi](https:://lib.rs/yansi) color types
4+
5+
[![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]
6+
![License](https://img.shields.io/crates/l/anstyle-yansi.svg)
7+
[![Crates Status](https://img.shields.io/crates/v/anstyle-yansi.svg)](https://crates.io/crates/anstyle-yansi)
8+
9+
## License
10+
11+
Licensed under either of
12+
13+
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
14+
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
15+
16+
at your option.
17+
18+
### Contribution
19+
20+
Unless you explicitly state otherwise, any contribution intentionally
21+
submitted for inclusion in the work by you, as defined in the Apache-2.0
22+
license, shall be dual licensed as above, without any additional terms or
23+
conditions.
24+
25+
[Crates.io]: https://crates.io/crates/anstyle-yansi
26+
[Documentation]: https://docs.rs/anstyle-yansi

0 commit comments

Comments
 (0)