Compare commits

...

5 Commits

Author SHA1 Message Date
Bevan Hunt 9db76e4800 fix typo 2021-03-20 14:59:22 -07:00
Bevan Hunt bde8966864 add new category 2021-03-20 14:44:06 -07:00
Bevan Hunt 940ad2ece9 add catergories 2021-03-20 14:41:38 -07:00
Bevan Hunt aee7b072fa add catergory 2021-03-20 14:37:51 -07:00
Bevan Hunt b55bd1f711 update readme 2021-03-20 11:23:37 -07:00
3 changed files with 8 additions and 7 deletions

2
Cargo.lock generated
View File

@ -451,7 +451,7 @@ dependencies = [
[[package]]
name = "broker"
version = "6.0.3"
version = "6.0.8"
dependencies = [
"anyhow",
"async-std",

View File

@ -1,12 +1,13 @@
[package]
name = "broker"
version = "6.0.3"
version = "6.0.8"
authors = ["Bevan Hunt <bevan@bevanhunt.com>"]
edition = "2018"
license = "MIT"
keywords = ["sse", "api", "baas", "broker", "real-time"]
description = "Real-time BaaS (Backend as a Service)"
repository = "https://github.com/apibillme/broker"
categories = ["web-programming::http-server", "database-implementations", "authentication"]
readme = "README.md"
[dependencies]

View File

@ -14,7 +14,7 @@ Broker follows an insert-only/publish/subscribe paradigm rather than a REST CRUD
### Features
* Very performant with a almost no CPU and memory usage
* Very performant with almost no CPU and memory usage
* Under 500 lines of code
* Secure Real-time Event Stream via SSE - requires the use of [broker-client](https://www.npmjs.com/package/broker-client)
* Supports CORS
@ -57,9 +57,9 @@ POST /users
- public endpoint
- POST JSON to create a user
```json
{"username":{...}, "password":{...}, "collection_id":{...}, "tenant_id":{...}}
{"username":{...}, "password":{...}}
```
- where {...} is for username and string, password a string, collection_id is the uuid of the event collection for user info, tenant_id is the uuid of the tenant
- where {...} is for username is a string and password is a string
will return `200` or `500` or `400`
@ -73,7 +73,7 @@ POST /login
```json
{"username":{...}, "password":{...}}
```
- where {...} is for username a string and password a string
- where {...} is for username is a string and password is a string
will return
```json
@ -88,7 +88,7 @@ GET /sse
```
- authenticated endpoint (Authorization: Bearer {jwt})
- connect your sse-client to this endpoint using [broker-client](https://www.npmjs.com/package/broker-client)
- note: broker-client uses fetch as eventsource doesn't support headers
- `note`: broker-client uses fetch as eventsource doesn't support headers
#### Step 4 - insert an event