working on README

This commit is contained in:
Julien Neuhart
2018-04-06 17:59:14 +02:00
parent 62c72d293e
commit cdeef33ff7
2 changed files with 50 additions and 0 deletions

View File

@@ -22,3 +22,28 @@
</p>
---
# Menu
* [Quick start](#quick-start)
* [API](#api)
* [Custom implementation](#custom-implementation)
* [Scalability](#scalability)
## Quick start
```sh
$ docker run --rm -p 3000:3000 thecodingmachine/gotenberg:{{ .Orbit.Branch }}
```
The API is now available through `http://127.0.0.1:3000`.
## API
## Custom implementation
## Scalability
---
Would you like to update this documentation ? Feel free to open an [issue](../../issues).

View File

@@ -22,3 +22,28 @@
</p>
---
# Menu
* [Quick start](#quick-start)
* [API](#api)
* [Custom implementation](#custom-implementation)
* [Scalability](#scalability)
## Quick start
```sh
$ docker run --rm -p 3000:3000 thecodingmachine/gotenberg:1.0.0
```
The API is now available through `http://127.0.0.1:3000`.
## API
## Custom implementation
## Scalability
---
Would you like to update this documentation ? Feel free to open an [issue](../../issues).