Skip to content

Commit

Permalink
docs: update readme (#1)
Browse files Browse the repository at this point in the history
* docs: update readme

* fix badges
  • Loading branch information
Daniel-Aaron-Bloom authored May 3, 2024
1 parent 424601d commit 88bc4fe
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 1 deletion.
3 changes: 3 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,6 @@ categories = ["development-tools::testing"]
[dependencies]
once_cell = "1"
tested-fixture-macros = { path = "./macros", version = "1" }

[badges]
github = { repository = "Daniel-Aaron-Bloom/tested-fixture", workflow = "Rust" }
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[![Crates.io](https://img.shields.io/crates/v/tested-fixture.svg)](https://crates.io/crates/tested-fixture)
[![Workflow Status](https://github.com/Daniel-Aaron-Bloom/tested-fixture/workflows/Rust/badge.svg)](https://github.com/Daniel-Aaron-Bloom/tested-fixture/actions?query=workflow%3A%22Rust%22)

# tested-fixture

Attribute macro for creating fixtures from tests
Expand Down Expand Up @@ -105,4 +108,11 @@ types of `Termination`

Right now this crate does not support async tests.

License: MIT
## License

Licensed under
* MIT license ([LICENSE](LICENSE) or https://opensource.org/licenses/MIT)


[`tested_fixture`]: https://docs.rs/tested-fixture/latest/tested_fixture/attr.tested_fixture.html "attr tested_fixture::tested_fixture"
[`std::process::Termination`]: https://doc.rust-lang.org/nightly/std/process/trait.Termination.html "trait std::process::Termination"
15 changes: 15 additions & 0 deletions README.tpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[![Crates.io](https://img.shields.io/crates/v/tested-fixture.svg)](https://crates.io/crates/tested-fixture)
{{badges}}

# {{crate}}

{{readme}}

## License

Licensed under
* MIT license ([LICENSE](LICENSE) or https://opensource.org/licenses/MIT)


[`tested_fixture`]: https://docs.rs/tested-fixture/latest/tested_fixture/attr.tested_fixture.html "attr tested_fixture::tested_fixture"
[`std::process::Termination`]: https://doc.rust-lang.org/nightly/std/process/trait.Termination.html "trait std::process::Termination"

0 comments on commit 88bc4fe

Please sign in to comment.