diff --git a/README.md b/README.md index 9cc33f85d..b4a37f03f 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Oracle Functions [![build status](https://github.com/fnproject/fn/badges/master/build.svg)](https://github.com/fnproject/fn/commits/master) +# Fn [![build status](https://github.com/fnproject/fn/badges/master/build.svg)](https://github.com/fnproject/fn/commits/master) -Oracle Functions is an event-driven, open source, [functions-as-a-service](serverless.md) compute +Fn is an event-driven, open source, [functions-as-a-service](serverless.md) compute platform that you can run anywhere. Some of it's key features: * Write once @@ -70,15 +70,15 @@ curl -LSs https://goo.gl/KKDFGn | sh This will download a shell script and execute it. If the script asks for a password, that is because it invokes sudo. -### Run Oracle Functions Server +### Run Fn Server -To get started quickly with Oracle Functions, just fire up a functions container: +To get started quickly with Fn, just fire up a functions container: ```sh fn start ``` -This will start Oracle Functions in single server mode, using an embedded database and message queue. You can find all the +This will start Fn in single server mode, using an embedded database and message queue. You can find all the configuration options [here](docs/operating/options.md). If you are on Windows, check [here](docs/operating/windows.md). --> @@ -97,7 +97,7 @@ import ( ) func main() { - fmt.Println("Hello from Oracle Functions!") + fmt.Println("Hello from Fn!") } ``` @@ -112,7 +112,7 @@ fn init /hello # This will run inside a container exactly how it will on the server fn run -# Deploy your functions to the Oracle Functions server (default localhost:8080) +# Deploy your functions to the Fn server (default localhost:8080) # This will create a route to your function as well fn deploy myapp ``` @@ -144,7 +144,7 @@ you can update your code and run `fn deploy myapp` again. ## User Interface -This is the graphical user interface for Oracle Functions. It is currently not buildable. +This is the graphical user interface for Fn. It is currently not buildable. ```sh docker run --rm -it --link functions:api -p 4000:4000 -e "API_URL=http://api:8080" treeder/functions-ui @@ -157,4 +157,4 @@ For more information, see: [https://github.com/treeder/functions-ui](https://git ### Check out the [Tutorial Series](examples/tutorial/). - It will demonstrate some of Oracle Functions capabilities through a series of exmaples. We'll try to show examples in most major languages. This is a great place to start! + 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!