Updated the document of examples/error (#652)

iron-io · Oct 3, 2017 · 61daa7a · 61daa7a
1 parent 4cf3fb7
commit 61daa7a
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 71 deletions.
diff --git a/examples/error/Dockerfile b/examples/error/Dockerfile
diff --git a/examples/error/README.md b/examples/error/README.md
@@ -2,37 +2,18 @@
 
 This images compares the payload info with the header.
 
-## Requirements
-
-- IronFunctions API
-
-## Development
-
-### Building image locally
-
-```
-# SET BELOW TO YOUR DOCKER HUB USERNAME
-USERNAME=YOUR_DOCKER_HUB_USERNAME
-
-# build it
-./build.sh
-```
-
-### Publishing to DockerHub
-
-```
-# tagging
-docker run --rm -v "$PWD":/app treeder/bump patch
-docker tag $USERNAME/func-error:latest $USERNAME/func-error:`cat VERSION`
-
-# pushing to docker hub
-docker push $USERNAME/func-error
-```
-
-### Testing image
-
 ```
-./test.sh
+# Create your func.yaml file
+fn init <YOUR_DOCKERHUB_USERNAME>/func-error
+# Build the function
+fn build
+# Test it
+echo '{"input": "yoooo"}' | fn run
+# Push it to Docker Hub
+fn push
+# Create routes to this function on IronFunctions
+fn apps create <YOUR_APP>
+fn routes create <YOUR_APP> /error
 ```
 
 ## Running it on IronFunctions
@@ -41,37 +22,17 @@ docker push $USERNAME/func-error
 
 ```
 # Set your Function server address
-# Eg. 127.0.0.1:8080
+# Eg. 
+# FUNCAPI=127.0.0.1:8080
+# APPNAME=error
 FUNCAPI=YOUR_FUNCTIONS_ADDRESS
+APPNAME=YOUR_APP
 ```
 
-### Running with IronFunctions
-
-With this command we are going to create an application with name `error`.
-
-```
-curl -X POST --data '{
-    "app": {
-        "name": "error",
-    }
-}' http://$FUNCAPI/v1/apps
-```
-
-Now, we can create our route
-
-```
-curl -X POST --data '{
-    "route": {
-        "image": "'$USERNAME'/func-error",
-        "path": "/error",
-    }
-}' http://$FUNCAPI/v1/apps/error/routes
-```
-
-#### Testing function
+### Testing function
 
 Now that we created our IronFunction route, let's test our new route
 
 ```
-curl -X POST --data '{"input": "yoooo"}' http://$FUNCAPI/r/error/error
-```
+curl -X POST --data '{"input": "yoooo"}' http://$FUNCAPI/r/$APPNAME/error
+```
diff --git a/examples/error/VERSION b/examples/error/VERSION
diff --git a/examples/error/build.sh b/examples/error/build.sh
diff --git a/examples/error/function.rb → examples/error/func.rb b/examples/error/function.rb → examples/error/func.rb
@@ -1,3 +1,4 @@
+require_relative 'bundle/bundler/setup'
 require 'json'
 
 payload = STDIN.read