docs: bring README.md in line with Standard Readme
This commit is contained in:
parent
f8396325e4
commit
3bee3e7af7
1 changed files with 31 additions and 0 deletions
31
README.md
31
README.md
|
|
@ -1,5 +1,7 @@
|
||||||
# zapier-docs-master
|
# zapier-docs-master
|
||||||
|
|
||||||
|
[](https://github.com/RichardLitt/standard-readme)
|
||||||
|
|
||||||
Summaries, NATS contracts, and message flows for every Verae Time × Zapier module.
|
Summaries, NATS contracts, and message flows for every Verae Time × Zapier module.
|
||||||
|
|
||||||
**Live catalog:** https://zapier.georgelambert.org/
|
**Live catalog:** https://zapier.georgelambert.org/
|
||||||
|
|
@ -68,3 +70,32 @@ Clone (SSH port 2223):
|
||||||
- [archive-nats.md](archive-nats.md) — bloom / multi-receipt design
|
- [archive-nats.md](archive-nats.md) — bloom / multi-receipt design
|
||||||
- [composition.md](composition.md) — HTTPS hops
|
- [composition.md](composition.md) — HTTPS hops
|
||||||
- `modules/<name>/SUMMARY.md` and `NATS.md`
|
- `modules/<name>/SUMMARY.md` and `NATS.md`
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Install](#install)
|
||||||
|
- [Usage](#usage)
|
||||||
|
- [Contributing](#contributing)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone ssh://git@git.georgelambert.org:2223/marchon/zapier-docs-master.git
|
||||||
|
cd zapier-docs-master
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# No single entrypoint is declared in this tree.
|
||||||
|
ls
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Questions: open an issue at https://git.georgelambert.org/marchon/zapier-docs-master/issues. Pull requests are accepted.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
UNLICENSED © George Lambert
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue