* Update Readme and add Makefile
* Skip stale tests (in wait for stdin support)

* Revert "Skip stale tests (in wait for stdin support)"

This reverts commit 228da3776503f40ca53df70a79a9e4a9c73fd8b5.
This commit is contained in:
Seif Lotfy سيف لطفي
2016-10-06 20:46:29 +02:00
committed by GitHub
parent 3bafb38e6d
commit b7bf73f5d2
12 changed files with 182 additions and 55 deletions

View File

@@ -1,24 +1,35 @@
## Building
## Contributing
### Build
First time or when a dependency changes or when the API changes, run:
```
glide install
make all
```
To quick build and run (using default database):
### Run Functions service
```sh
api.sh
First let's start our IronFunctions API
##### Run in Docker
```
make run-docker
```
To build the docker image:
will start Functions using an embedded `Bolt` database running on `:8080`.
```sh
build.sh
##### Running on Metal (recommended only on Linux)
```
./functions
```
## Releasing
will start Functions with a default of 1 async runner
```sh
release.sh
```
### Contributing
##### Code
* Fork the repo
* Fix an issue
* Create a Pull Request
* Sign the CLA
* Good Job! Thanks for being awesome!