docs: bring README.md in line with Standard Readme
This commit is contained in:
parent
f850002f1c
commit
b889b7bd72
1 changed files with 25 additions and 1 deletions
26
README.md
26
README.md
|
|
@ -1,6 +1,8 @@
|
||||||
# dev-overview
|
# dev-overview
|
||||||
|
|
||||||
Developer map of the Verae Time × Zapier **NATS message fabric**: what was designed, what is actually running on NS1, how a Zapier timestamp job reaches `api.veraetime.net` (or the mock) and comes back, and what is still unwired.
|
[](https://github.com/RichardLitt/standard-readme)
|
||||||
|
|
||||||
|
Developer map of the Verae Time × Zapier **NATS message fabric**: what was designed, what is actually running on...
|
||||||
|
|
||||||
**Forgejo:** https://git.georgelambert.org/marchon/dev-overview
|
**Forgejo:** https://git.georgelambert.org/marchon/dev-overview
|
||||||
**SSH:** `ssh://git@git.georgelambert.org:2223/marchon/dev-overview.git`
|
**SSH:** `ssh://git@git.georgelambert.org:2223/marchon/dev-overview.git`
|
||||||
|
|
@ -29,3 +31,25 @@ nats://10.10.10.21:4222,nats://10.10.10.22:4222,nats://10.10.10.23:4222
|
||||||
JetStream streams (replicas=3, file): `ZAPIER_JOBS`, `ZAPIER_EVENTS`, `ZAPIER_WEBHOOKS`, `ZAPIER_USAGE`, `VERAE_ARCHIVE`.
|
JetStream streams (replicas=3, file): `ZAPIER_JOBS`, `ZAPIER_EVENTS`, `ZAPIER_WEBHOOKS`, `ZAPIER_USAGE`, `VERAE_ARCHIVE`.
|
||||||
|
|
||||||
Public token-gated **client** edge (not cluster routes): `nats://<token>@70.88.205.138:4222`, `wss://nats.zapier.georgelambert.org`. Do not put this in Zapier.
|
Public token-gated **client** edge (not cluster routes): `nats://<token>@70.88.205.138:4222`, `wss://nats.zapier.georgelambert.org`. Do not put this in Zapier.
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone ssh://git@git.georgelambert.org:2223/marchon/dev-overview.git
|
||||||
|
cd dev-overview
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# No single entrypoint is declared in this tree.
|
||||||
|
ls
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Questions: open an issue at https://git.georgelambert.org/marchon/dev-overview/issues. Pull requests are accepted.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
UNLICENSED © George Lambert
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue