dethos
/
rusty-hub
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

small update to the readme file

This commit is contained in:
Gonçalo Valério 2019-06-30 21:44:17 +01:00
parent dad2993123
commit 6b3f200778
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,15 +1,16 @@
# 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
## Usage
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)
## 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