From da09f187419ace47452e72365972df55c1f8a89f Mon Sep 17 00:00:00 2001 From: Chad Arimura Date: Thu, 25 May 2017 14:42:33 -0700 Subject: [PATCH] readme mods --- examples/tutorial/README.md | 13 +++++++++---- examples/tutorial/hello/go/README.md | 17 ++++++++++++----- 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/examples/tutorial/README.md b/examples/tutorial/README.md index 1df9b7924..ab947e8ae 100644 --- a/examples/tutorial/README.md +++ b/examples/tutorial/README.md @@ -4,7 +4,12 @@ Welcome to the Oracle Functions Tutorial Series, the best way to get started with Oracle Functions and serverless computing. In the following tutorials, we'll gradually introduce many of the key features of Oracle Functions. -1. [Tutorial 1](examples/tutorial/hello): Learn the basics about sending data into your function -2. [Tutorial 2](examples/tutorial/params): Learn how to get parameters from a web request -3. [Tutorial 3](examples/tutorial/hotfunctions): Write your first HotFunction (stays alive to minimze latency between requests) -4. [Tutorial 4](): TBD \ No newline at end of file + +**[Tutorial 1](examples/tutorial/hello)** +: Learn the basics about sending data into your function + +**[Tutorial 2](examples/tutorial/params)**: Learn how to get parameters from a web request + +**[Tutorial 3](examples/tutorial/hotfunctions)**: Write your first HotFunction (stays alive to minimize latency between requests) + +**[Tutorial 4]()**: TBD diff --git a/examples/tutorial/hello/go/README.md b/examples/tutorial/hello/go/README.md index 1a27e91f9..5e2f7cbe0 100644 --- a/examples/tutorial/hello/go/README.md +++ b/examples/tutorial/hello/go/README.md @@ -2,7 +2,7 @@ This example will show you how to test and deploy Go (Golang) code to Oracle Functions. It will also demonstrate passing data in through stdin. -First, run the following commands to create, run, and deploy your function: +### First, run the following commands to create, run, and deploy your function: ```sh # Initialize your function creating a func.yaml file @@ -18,36 +18,43 @@ cat hello.payload.json | fn run # This will create a route to your function as well fn deploy myapp ``` -Now call your function: +### Now call your function: ```sh curl http://localhost:8080/r/myapp/hello ``` -Or call from a browser: [http://localhost:8080/r/myapp/hello](http://localhost:8080/r/myapp/hello) +### Or call from a browser: [http://localhost:8080/r/myapp/hello](http://localhost:8080/r/myapp/hello) -And now with the JSON input: +### And now with the JSON input: ```sh curl -H "Content-Type: application/json" -X POST -d @hello.payload.json http://localhost:8080/r/myapp/hello ``` -That's it! +### That's it! # In Review 1. We piped JSON data into the function at the command line + ```sh cat hello.payload.json | fn run ``` + 2. We received our input through stdin + ```go json.NewDecoder(os.Stdin).Decode(p) ``` + 3. We wrote our output to stdout + ```go fmt.Printf("Hello") ``` + 4. We sent stderr to the server logs + ```go log.Println("here") ```