update docs and contributing

This commit is contained in:
Pedro Nasser
2016-07-27 17:51:51 -03:00
parent f09a4cc94f
commit 338498e94d
14 changed files with 194 additions and 350 deletions

View File

@@ -1,23 +1,24 @@
## Building
## Building/Testing
Build:
```sh
# one time:
First time or when a dependency changes or when the API changes, run:
```
glide install
# then every time
./build.sh
```
Test it, the iron token and project id are for cache.
To quick build and run (using default database):
```sh
docker run --env-file .env --rm -it --privileged -p 8080:8080 iron/functions
hack/api.sh
```
To build the docker image:
```sh
hack/build.sh
```
## Releasing
```sh
./release.sh
hack/release.sh
```