Merge pull request #374 from fnproject/docs-up-0928

Docs up 0928 - Fixes to main and tutorial README.md files

README.md

@@ -19,7 +19,10 @@ platform that you can run anywhere. Some of it's key features:
 ## Prequisites
 
 * Docker 17.05 or later installed and running
-* Logged into Docker Hub (`docker login`)
+* A Docker Hub account ([Docker Hub](https://hub.docker.com/))
+* Log Docker into your Docker Hub account
+    * Linux: `docker login`
+    * MacOS: Click Docker icon in menu bar. Select **Sign In**.
 
 ## Quickstart
 
@@ -27,11 +30,12 @@ platform that you can run anywhere. Some of it's key features:
 
 The command line tool isn't required, but it sure makes things a lot easier. There are a few options to install it:
 
-#### 1. Homebrew
+#### 1. Homebrew - MacOS
 
 If you're on a Mac and use [Homebrew](https://brew.sh/), this one is for you: 
 
 ```sh
+brew update
 brew install fn
 ```
 
@@ -127,7 +131,7 @@ you can update your code and run `fn deploy myapp` again.
 ## Stay Informed
 
 * [Blog](https://medium.com/fnproject)
-* [Twitter](https://twitter.com/fnproj) TODO
+* [Twitter](https://twitter.com/fnproj)
 
 ## Get Involved
 
@@ -137,16 +141,16 @@ you can update your code and run `fn deploy myapp` again.
 
 ## User Interface
 
-This is the graphical user interface for Fn. It is currently not buildable.
+Check out this graphical user interface for Fn.
 
 ```sh
-docker run --rm -it --link functions:api -p 4000:4000 -e "API_URL=http://api:8080" treeder/functions-ui
+docker run --rm -it --link functions:api -p 4000:4000 -e "API_URL=http://api:8080" fnproject/ui
 ```
 
-For more information, see: [https://github.com/treeder/functions-ui](https://github.com/treeder/functions-ui)
+For more information, see: [https://github.com/fnproject/ui](https://github.com/fnproject/ui)
 
 ## Next up
 
 ### Check out the [Tutorial Series](examples/tutorial/)
 
- It will demonstrate some of Fn capabilities through a series of exmaples. We'll try to show examples in most major languages. This is a great place to start!
+The series will demonstrate some of the core Fn capabilities through a series of exmaples. We'll try to show examples in most major languages. This is a great place to start!

examples/tutorial/README.md

@@ -1,15 +1,31 @@
 
 # Tutorial Series
 
-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.
+Welcome to the Fn Tutorial Series, the best way to get started with Fn and serverless computing. In the following tutorials, we'll gradually introduce many of the key features of Fn.
 
+## Guided Tour
 
-**[Tutorial 1](examples/tutorial/hello)**
-: Learn the basics about sending data into your function
+### Part 1
 
-**[Tutorial 2](examples/tutorial/params)**: Learn how to get parameters from a web request
+Learn the basics about sending data into your function. Choose your language:
 
-**[Tutorial 3](examples/tutorial/hotfunctions)**: Write your first HotFunction (stays alive to minimize latency between requests)
+* [go](hello/go)
+* [java](hello/java)
+* [node](hello/node)
+* [php](hello/php)
+* [python](hello/python)
+* [ruby](hello/ruby)
+* [rust](hello/rust) 
 
-**[Tutorial 4]()**: TBD
+### Part 2
+
+Learn how to get parameters from a web request. [Click here](params)
+
+### Part 3
+
+Write your first HotFunction (stays alive to minimize latency between requests). [Click here](hotfunctions/http)
+
+## Other Tutorials
+
+* [Introduction to Fn](https://github.com/fnproject/tutorials/tree/master/Introduction)
+* [Introduction to Java Fn](https://github.com/fnproject/tutorials/tree/master/JavaFDKIntroduction)

examples/tutorial/hello/go/README.md

@@ -63,4 +63,4 @@ In Go, simply put them all in the `vendor/` directory.
 
 
 # Next Up
-## [Tutorial 2: Input Parameters](examples/tutorial/params)
+## [Part 2: Input Parameters](../../params)

examples/tutorial/hello/java/README.md

@@ -48,4 +48,4 @@ That's it!
 
 
 # Next Up
-## [Tutorial 2: Input Parameters](examples/tutorial/params)
+## [Part 2: Input Parameters](../../params)

examples/tutorial/hello/node/README.md

@@ -77,7 +77,7 @@ request('http://www.google.com', function (error, response, body) {
 
 
 # Next Up
-## [Tutorial 2: Input Parameters](examples/tutorial/params)
+## [Part 2: Input Parameters](../../params)
 
 
 

examples/tutorial/hello/php/README.md

@@ -78,4 +78,4 @@ Open `func.php` to see it in action.
 
 
 # Next Up
-## [Tutorial 2: Input Parameters](examples/tutorial/params)
+## [Part 2: Input Parameters](../../params)

examples/tutorial/hello/python/README.md

@@ -64,4 +64,4 @@ In Python, we create a [requirements](https://pip.pypa.io/en/stable/user_guide/)
 
 
 # Next Up
-## [Tutorial 2: Input Parameters](examples/tutorial/params)
+## [Part 2: Input Parameters](../../params)

examples/tutorial/hello/ruby/README.md

@@ -79,7 +79,7 @@ Open `func.rb` to see it in action.
 
 
 # Next Up
-## [Tutorial 2: Input Parameters](examples/tutorial/params)
+## [Part 2: Input Parameters](../../params)
 
 
 

examples/tutorial/hello/rust/README.md

@@ -90,4 +90,4 @@ That's it!
 
 
 # Next Up
-## [Tutorial 2: Input Parameters](examples/tutorial/params)
+## [Part 2: Input Parameters](../../params)