small update to the readme file
This commit is contained in:
parent
dad2993123
commit
6b3f200778
17
README.md
17
README.md
|
@ -1,15 +1,16 @@
|
||||||
# Rusty hub
|
# Rusty hub
|
||||||
|
|
||||||
This project intends be an easy to use and deploy [Websub Hub](https://www.w3.org/TR/websub/#hub). It still is a work in progress and at this moment is not intented to use in production.
|
This project started as a learning exercice and as a secondary goal it intends to be an easy to use and deploy [Websub Hub](https://www.w3.org/TR/websub/#hub).
|
||||||
|
|
||||||
## Installation
|
It still is a work in progress and at this moment is not intented to use in production.
|
||||||
|
|
||||||
Instructions will be added soon
|
**CI Status**: [![CircleCI](https://circleci.com/gh/dethos/rusty-hub.svg?style=svg)](https://circleci.com/gh/dethos/rust-hub)
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Instructions will be added soon
|
|
||||||
|
|
||||||
## Development Environment
|
## Development Environment
|
||||||
|
|
||||||
Instructions will be added soon
|
To start hacking on this project you just need to have your stable rust environment set up and then:
|
||||||
|
|
||||||
|
1. Clone this repository.
|
||||||
|
2. Run `cargo build` to build the project and install the dependencies.
|
||||||
|
3. Run `cargo test` to run the test suite and be sure everything is working properly
|
||||||
|
4. Run `cargo run` to manually test
|
||||||
|
|
Loading…
Reference in New Issue