rusty-hub/README.md

27 lines
1020 B
Markdown
Raw Permalink Normal View History

2018-06-23 19:52:45 +02:00
# Rusty hub
2019-06-30 22:44:17 +02:00
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).
2018-06-23 19:52:45 +02:00
2019-09-03 14:25:14 +02:00
It still is a work in progress and at this moment it is still not ready to be used.
2018-06-23 19:52:45 +02:00
2019-06-30 22:44:17 +02:00
**CI Status**: [![CircleCI](https://circleci.com/gh/dethos/rusty-hub.svg?style=svg)](https://circleci.com/gh/dethos/rust-hub)
2018-06-23 19:52:45 +02:00
2019-09-03 14:25:14 +02:00
## Missing features
Below are some missing features that are required for the hub to work properly:
- [ ] Subscription validation
- [ ] Subscription expiration
- [ ] Content distribution
- [ ] Authenticated content distribution
- [ ] Change default settings through a `config` file
2018-06-23 19:52:45 +02:00
## Development Environment
2019-06-30 22:44:17 +02:00
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