Skip to content

Commit 28dd4f5

Browse files
committed
docs: Add README
1 parent d7ebe66 commit 28dd4f5

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# git-fixture
2+
3+
> Reproducible git trees for bug reporting and testing
4+
5+
[![codecov](https://codecov.io/gh/gitext-rs/git-fixture/branch/master/graph/badge.svg)](https://codecov.io/gh/gitext-rs/git-fixture)
6+
[![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]
7+
![License](https://img.shields.io/crates/l/git-fixture.svg)
8+
[![Crates Status](https://img.shields.io/crates/v/git-fixture.svg)](https://crates.io/crates/git-fixture)
9+
10+
Dual-licensed under [MIT](LICENSE-MIT) or [Apache 2.0](LICENSE-APACHE)
11+
12+
## Documentation
13+
14+
- [About](#about)
15+
- [Install](#install)
16+
- [Getting Started](#getting-started)
17+
- [Reference](docs/schema.json)
18+
- [FAQ](#faq)
19+
- [Contribute](CONTRIBUTING.md)
20+
- [CHANGELOG](CHANGELOG.md)
21+
22+
## About
23+
24+
25+
## Example
26+
27+
28+
## Install
29+
30+
[Download](https://github.com/gitext-rs/git-fixture/releases) a pre-built binary
31+
(installable via [gh-install](https://github.com/crate-ci/gh-install)).
32+
33+
Or use rust to install:
34+
```bash
35+
cargo install git-fixture
36+
```
37+
38+
### Uninstall
39+
40+
See the uninstall method for your installer.
41+
42+
## Getting Started
43+
44+
## FAQ
45+
46+
[Crates.io]: https://crates.io/crates/git-fixture
47+
[Documentation]: https://docs.rs/git-fixture

0 commit comments

Comments
 (0)