docs: bring README.md in line with Standard Readme
Some checks failed
ci / catalog (push) Has been cancelled
Some checks failed
ci / catalog (push) Has been cancelled
This commit is contained in:
parent
25c930e760
commit
f6b859bcb0
1 changed files with 23 additions and 0 deletions
23
README.md
23
README.md
|
|
@ -1,5 +1,7 @@
|
||||||
# nats-service-endpoints
|
# nats-service-endpoints
|
||||||
|
|
||||||
|
[](https://github.com/RichardLitt/standard-readme)
|
||||||
|
|
||||||
Canonical list of NATS subjects for Verae / PFC / secure-messaging.
|
Canonical list of NATS subjects for Verae / PFC / secure-messaging.
|
||||||
|
|
||||||
* `catalog/endpoints.json` — secure-messaging + admin-config endpoints (full records)
|
* `catalog/endpoints.json` — secure-messaging + admin-config endpoints (full records)
|
||||||
|
|
@ -13,3 +15,24 @@ Passthrough: the **destination** (and NATS subject) may be in the clear; the
|
||||||
**body** is ciphertext. The broker is untrusted.
|
**body** is ciphertext. The broker is untrusted.
|
||||||
|
|
||||||
Not a HIPAA/SOC 2/ISO certificate.
|
Not a HIPAA/SOC 2/ISO certificate.
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone ssh://git@git.georgelambert.org:2223/marchon/nats-service-endpoints.git
|
||||||
|
cd nats-service-endpoints
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```sh
|
||||||
|
make
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Questions: open an issue at https://git.georgelambert.org/marchon/nats-service-endpoints/issues. Pull requests are accepted.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT © George Lambert
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue