From 6b3f200778f40ff549af5cd725b05ab2d9d9e637 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gon=C3=A7alo=20Val=C3=A9rio?= Date: Sun, 30 Jun 2019 21:44:17 +0100 Subject: [PATCH] small update to the readme file --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 17a4383..8521e98 100644 --- a/README.md +++ b/README.md @@ -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