docs: bring README.md in line with Standard Readme
This commit is contained in:
parent
d25996a181
commit
280ad2f9f1
1 changed files with 24 additions and 0 deletions
24
README.md
24
README.md
|
|
@ -1,5 +1,7 @@
|
||||||
# verae-fleet
|
# verae-fleet
|
||||||
|
|
||||||
|
[](https://github.com/RichardLitt/standard-readme)
|
||||||
|
|
||||||
Operator control plane for Verae Time × Zapier **runtime** services:
|
Operator control plane for Verae Time × Zapier **runtime** services:
|
||||||
|
|
||||||
- a **list** of every service and its config file
|
- a **list** of every service and its config file
|
||||||
|
|
@ -46,3 +48,25 @@ NS1 overlay (no rewrite of git JSON): `FLEET_FILE=overlays/ns1/fleet.json` `FLEE
|
||||||
Install on Docker / Proxmox / metal: https://zapier.georgelambert.org/packages/verae-ops/README.pdf
|
Install on Docker / Proxmox / metal: https://zapier.georgelambert.org/packages/verae-ops/README.pdf
|
||||||
|
|
||||||
Clone: `ssh://git@git.georgelambert.org:2223/marchon/verae-fleet.git`
|
Clone: `ssh://git@git.georgelambert.org:2223/marchon/verae-fleet.git`
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone ssh://git@git.georgelambert.org:2223/marchon/verae-fleet.git
|
||||||
|
cd verae-fleet
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm install
|
||||||
|
npm start
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Questions: open an issue at https://git.georgelambert.org/marchon/verae-fleet/issues. Pull requests are accepted.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
UNLICENSED © George Lambert
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue