Skip to content

Commit efe2cdd

Browse files
committed
docs: more on README
1 parent e438224 commit efe2cdd

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,30 @@
11
# envtestkit
22

3-
Test kit for logics with environment variable involvements.
4-
53
[![ci](https://github.com/codinaut/envtestkit/workflows/ci/badge.svg)](https://github.com/codinaut/envtestkit/actions?query=workflow%3Aci)
64
[![crates.io](https://img.shields.io/crates/v/envtestkit.svg)](https://crates.io/crates/envtestkit)
75
[![docs.rs](https://docs.rs/envtestkit/badge.svg)](https://docs.rs/envtestkit)
86
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
97

8+
Test kit for logics with environment variable involvements.
9+
10+
## Usage
11+
12+
See [the documentation](https://docs.rs/envtestkit).
13+
14+
## Hacking
15+
16+
This repository uses [semantic-release](https://github.com/semantic-release/semantic-release) for automated release and crate publishing. Please look at [Angular commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
17+
18+
To test this crate:
19+
```sh
20+
cargo test
21+
```
22+
23+
To see what's happening if environment tests aren't locked:
24+
```sh
25+
cargo test --examples -- --ignored
26+
```
27+
1028
## License
1129

1230
[MIT](LICENSE).

0 commit comments

Comments
 (0)