From cdeef33ff7e713b16375d92b710607307d9699f1 Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Fri, 6 Apr 2018 17:59:14 +0200 Subject: [PATCH] working on README --- .blueprints/README.blueprint.md | 25 +++++++++++++++++++++++++ README.md | 25 +++++++++++++++++++++++++ 2 files changed, 50 insertions(+) diff --git a/.blueprints/README.blueprint.md b/.blueprints/README.blueprint.md index 0224a973..a9740a86 100644 --- a/.blueprints/README.blueprint.md +++ b/.blueprints/README.blueprint.md @@ -22,3 +22,28 @@

--- + +# 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). \ No newline at end of file diff --git a/README.md b/README.md index 9e4e2b1b..2aaf78f0 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,28 @@

--- + +# 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). \ No newline at end of file