Add README for hotfunctions go example and update docs to point to it

This commit is contained in:
Nigel Deakin
2017-09-29 12:01:29 +01:00
parent 4afe06adc7
commit 16cdd98a62
4 changed files with 29 additions and 8 deletions

View File

@@ -19,8 +19,7 @@ input/output.
## Implementing a hot function
In the [examples directory](https://github.com/treeder/functions/blob/master/examples/hotfunctions/http/func.go), there is one simple implementation of a hot function
which we are going to get in the details here.
Let's look at a simple hot function. The examples directory contains a [simple example of a hot function written in go](/examples/tutorial/hotfunctions/http/go). Here's [func.go](/examples/tutorial/hotfunctions/http/go/func.go) from that example.
The basic cycle comprises three steps: read standard input up to a previosly
known point, process the work, the write the output to stdout with some

View File

@@ -0,0 +1,22 @@
# Hot Function Example
This is an example of a hot function. The [hot function documentation](/docs/hot-functions.md) contains an analysis of how this example works.
### How to run the example
Install the CLI tool, start a Fn server and run `docker login` to login to DockerHub. See the [front page](README.md) for instructions.
Set your Docker Hub username
```export FN_REGISTRY=<DOCKERHUB_USERNAME>
```
Build and deploy the function to the Fn server (default localhost:8080)
fn deploy --app hot-app
```
Now call your function:
```curl -X POST -d "World" http://localhost:8080/r/hot-app/%2Fhotfn-go
```

View File

@@ -0,0 +1,6 @@
name: hotfunction-http
version: 0.0.10
runtime: go
entrypoint: ./func
format: http
path: /hotfn-go

View File

@@ -1,6 +0,0 @@
{"route":{
"memory": 64,
"type": "sync",
"config": null,
"format": "http"
}}