mirror of https://github.com/apibillme/broker
update readme
This commit is contained in:
parent
686819d09a
commit
3cfd928ce0
|
@ -386,7 +386,7 @@ dependencies = [
|
|||
|
||||
[[package]]
|
||||
name = "broker"
|
||||
version = "1.0.1"
|
||||
version = "1.0.2"
|
||||
dependencies = [
|
||||
"actix-cors 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"actix-rt 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
[package]
|
||||
name = "broker"
|
||||
version = "1.0.1"
|
||||
version = "1.0.2"
|
||||
authors = ["Bevan Hunt <bevan@bevanhunt.com>"]
|
||||
edition = "2018"
|
||||
license = "MIT"
|
||||
|
|
21
README.md
21
README.md
|
@ -1,6 +1,7 @@
|
|||
## Broker - Real-time Zero-Code API Server
|
||||
|
||||
[![crates.io](https://meritbadge.herokuapp.com/broker)](https://crates.io/crates/broker)
|
||||
[![broker](https://snapcraft.io//broker/badge.svg)](https://snapcraft.io/broker)
|
||||
|
||||
### Purpose
|
||||
|
||||
|
@ -144,6 +145,19 @@ async fn main() -> std::result::Result<(), std::io::Error> {
|
|||
- the SECRET (for jwts) needs to be passed in as an environment variable
|
||||
- the file database saves to ``` ./tmp ``` of the project root
|
||||
|
||||
### Install
|
||||
|
||||
#### Linux
|
||||
```bash
|
||||
sudo snap install broker
|
||||
```
|
||||
|
||||
- the PORT needs to be passed in as an environment variable
|
||||
- the ORIGIN needs to be passed in as an environment variable
|
||||
- the EXPIRY (for jwts) needs to be passed in as an environment variable
|
||||
- the SECRET (for jwts) needs to be passed in as an environment variable
|
||||
- the file database saves to ``` ./tmp ``` of the project root
|
||||
|
||||
### Run Example
|
||||
|
||||
- ``` make ```
|
||||
|
@ -163,10 +177,3 @@ async fn main() -> std::result::Result<(), std::io::Error> {
|
|||
* [Event Sourcing](https://microservices.io/patterns/data/event-sourcing.html)
|
||||
* [Best in Place](https://github.com/bernat/best_in_place)
|
||||
* [Brock Whitten](https://www.youtube.com/watch?v=qljYMEfVukU)
|
||||
|
||||
### Install
|
||||
|
||||
#### Linux
|
||||
```bash
|
||||
sudo snap install broker
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue