diff --git a/README.md b/README.md index e69de29b..b8dd5006 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,39 @@ +# fakehub + +[![DevOps By Rultor.com](http://www.rultor.com/b/h1alexbel/fakehub)](http://www.rultor.com/p/h1alexbel/fakehub) +[![We recommend IntelliJ IDEA](https://www.elegantobjects.org/intellij-idea.svg)](https://www.jetbrains.com/idea/) + +[![cargo](https://github.com/h1alexbel/fakehub/actions/workflows/cargo.yml/badge.svg)](https://github.com/h1alexbel/fakehub/actions/workflows/cargo.yml) +[![Crates.io Version](https://img.shields.io/crates/v/fakehub)](https://crates.io/crates/fakehub) +[![PDD status](http://www.0pdd.com/svg?name=h1alexbel/fakehub)](http://www.0pdd.com/p?name=h1alexbel/fakehub) +[![Hits-of-Code](https://hitsofcode.com/github/h1alexbel/fakehub)](https://hitsofcode.com/view/github/h1alexbel/fakehub) +[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/h1alexbel/fakehub/blob/master/LICENSE.txt) +[![Known Vulnerabilities](https://snyk.io/test/github/h1alexbel/fakehub/badge.svg)](https://snyk.io/test/github/h1alexbel/fakehub) + +fakehub - Fully functioning mock version of a GitHub API, which would support +all functions, but work locally, with absolutely no connection to GitHub. + +**Motivation**. There are many applications that use GitHub API for different +purposes. All of them need to create automated tests, which need to mock the +API server somehow. We offer a fully functioning mock version of a GitHub API, +which would support all functions, but work locally, with absolutely no +connection to GitHub. + +## How to use? + +TBD.. + +## How to contribute? + +Fork repository, make changes, send us a [pull request](https://www.yegor256.com/2014/04/15/github-guidelines.html). +We will review your changes and apply them to the `master` branch shortly, +provided they don't violate our quality standards. To avoid frustration, +before sending us your pull request please run full cargo build: + +```bash +cargo test +``` + +You will need [Rust] installed on your system. + +[Rust]: https://www.rust-lang.org/tools/install