mirror of https://github.com/apibillme/broker
update readme and toml description
This commit is contained in:
parent
7e54b31522
commit
3d04ea322b
|
@ -113,7 +113,7 @@ dependencies = [
|
|||
|
||||
[[package]]
|
||||
name = "broker"
|
||||
version = "4.2.6"
|
||||
version = "4.2.7"
|
||||
dependencies = [
|
||||
"Inflector 0.11.4 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"bcrypt 0.6.1 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
[package]
|
||||
name = "broker"
|
||||
version = "4.2.6"
|
||||
version = "4.2.7"
|
||||
authors = ["Bevan Hunt <bevan@bevanhunt.com>"]
|
||||
edition = "2018"
|
||||
license = "MIT"
|
||||
keywords = ["sse", "api", "zero-code", "broker", "real-time"]
|
||||
description = "Real-time Zero-Code API Server"
|
||||
keywords = ["sse", "api", "baas", "broker", "real-time"]
|
||||
description = "Real-time BaaS (Backend as a Service)"
|
||||
repository = "https://github.com/apibillme/broker"
|
||||
homepage = "https://apibill.me"
|
||||
readme = "README.md"
|
||||
|
|
19
README.md
19
README.md
|
@ -1,11 +1,11 @@
|
|||
## Broker - Real-time Zero-Code API Server
|
||||
## Broker - Real-time BaaS (Backend as a Service)
|
||||
|
||||
[![crates.io](https://meritbadge.herokuapp.com/broker)](https://crates.io/crates/broker)
|
||||
[![broker](https://snapcraft.io//broker/badge.svg)](https://snapcraft.io/broker)
|
||||
|
||||
### Purpose
|
||||
|
||||
The purpose of this library is to be your real-time zero-code API server.
|
||||
The purpose of this library is to be your real-time BaaS (Backend as a Service).
|
||||
|
||||
Broker is a SSE message broker that requires you write no backend code to have a full real-time API.
|
||||
|
||||
|
@ -45,6 +45,13 @@ The side-effect of this system is that the latest event is the schema. Old event
|
|||
* [React Hook Form](https://react-hook-form.com/) - Best form library for React
|
||||
* [React Debounce Input](https://www.npmjs.com/package/react-debounce-input) - React input for Real-time Submission (Edit in Place forms)
|
||||
|
||||
### Broker FAQ
|
||||
* Why compete against Parse Server and Firebase?
|
||||
* [Firebase](https://firebase.google.com/) is not open-source, is not free, and has complicated pricing. [Parse Server](https://github.com/parse-community/parse-server) doesn't have real-time features and is about 30,000 LOC of JS.
|
||||
|
||||
* Will broker work with mobile apps?
|
||||
* Yes with React Native. There may be native 3rd party libraries for SSE that work. In the future official libraries may be made available for native platforms.
|
||||
|
||||
### API
|
||||
|
||||
#### Step 1 - create a user
|
||||
|
@ -186,14 +193,6 @@ pub async fn main() {
|
|||
- the secret (for jwts) needs to be passed in as a flag
|
||||
- example: sudo broker -port 8080 -origin http://localhost:3000 -expiry 3600 -secret secret
|
||||
|
||||
### Run Example
|
||||
|
||||
- ``` make ```
|
||||
|
||||
### Run Integration Tests
|
||||
|
||||
- ``` cargo test ```
|
||||
|
||||
### Under the Hood
|
||||
|
||||
- [warp](https://crates.io/crates/warp) - web framework
|
||||
|
|
|
@ -1,9 +1,9 @@
|
|||
name: broker # you probably want to 'snapcraft register <name>'
|
||||
base: core18 # the base snap is the execution environment for this snap
|
||||
version: '4.2.6' # just for humans, typically '1.2+git' or '1.3.2'
|
||||
summary: Real-time Zero-Code API Server # 79 char long summary
|
||||
version: '4.2.7' # just for humans, typically '1.2+git' or '1.3.2'
|
||||
summary: Real-time BaaS (Backend as a Service) # 79 char long summary
|
||||
description: |
|
||||
The purpose of this library is to be your real-time zero-code API server.
|
||||
The purpose of this library is to be your real-time BaaS (Backend as a Service).
|
||||
Broker is a SSE message broker that requires you write no backend code to have a full real-time API.
|
||||
Broker is born from the need that rather than building a complex REST API with web-sockets and a SQL database to provide reactive web forms (like for React) there must be a simpler way.
|
||||
Broker follows an insert-only/publish/subscribe paradigm rather than a REST CRUD paradigm.
|
||||
|
|
Loading…
Reference in New Issue