diff --git a/README.md b/README.md index b4a37f03f..58b345bac 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Fn [![build status](https://github.com/fnproject/fn/badges/master/build.svg)](https://github.com/fnproject/fn/commits/master) +# Fn [![CircleCI](https://circleci.com/gh/fnproject/fn.svg?style=svg&circle-token=6a62ac329bc5b68b484157fbe88df7612ffd9ea0)](https://circleci.com/gh/fnproject/fn) - + 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: @@ -22,57 +22,21 @@ platform that you can run anywhere. Some of it's key features: * Docker 17.05 or later installed and running * Logged into Docker Hub (`docker login`) -## Usage - -### Installation (if running locally) - -NOTE: The following instructions apply while the project is a private repo. This will -build the Functions server and the CLI tool directly from the repo instead of -using pre-built containers. Once the project is public, these steps will be unnecessary. - -```sh -# Build and Install CLI tool -cd fn -make dep # just once -make install - -# Build and Run Functions Server -cd .. -make dep # just once -make run # will build as well -``` - -### Installation (if using internal alpha service) - -Set your system to point to the internal service on BMC: - -```sh -export API_URL=http://129.146.10.253:80 -``` - -Download the pre-built CLI binary: - -1. Visit: https://github.com/fnproject/fn/tree/master/fn/releases/download/0.3.2 -2. Download the CLI for your platform -3. Put in /usr/local/bin -4. chmod +x - - - - ### Your First Function Functions are small but powerful blocks of code that generally do one simple thing. Forget about monoliths when using functions, just focus on the task that you want the function to perform. diff --git a/cli/install b/cli/install index bfd85070d..9683fdc74 100755 --- a/cli/install +++ b/cli/install @@ -3,7 +3,7 @@ set -e # Install script to install fn -release="0.3.7" +version="0.3.26" command_exists() { command -v "$@" > /dev/null 2>&1 @@ -54,24 +54,24 @@ else exit 1 fi -url='https://github.com/fnproject/fn/cli/releases/download' +url='https://github.com/fnproject/cli/releases/download' # perform some very rudimentary platform detection case "$(uname)" in Linux) - $sh_c "$curl /usr/local/bin/fn $url/$release/fn_linux" + $sh_c "$curl /usr/local/bin/fn $url/$version/fn_linux" $sh_c "chmod +x /usr/local/bin/fn" fn --version exit 0 ;; Darwin) - $sh_c "$curl /usr/local/bin/fn $url/$release/fn_mac" + $sh_c "$curl /usr/local/bin/fn $url/$version/fn_mac" $sh_c "chmod +x /usr/local/bin/fn" fn --version exit 0 ;; WindowsNT) - $sh_c "$curl $url/$release/fn.exe" + $sh_c "$curl $url/$version/fn.exe" # TODO how to make executable? chmod? fn.exe --version exit 0 diff --git a/cli/install.sh b/cli/install.sh index bfd85070d..9683fdc74 100644 --- a/cli/install.sh +++ b/cli/install.sh @@ -3,7 +3,7 @@ set -e # Install script to install fn -release="0.3.7" +version="0.3.26" command_exists() { command -v "$@" > /dev/null 2>&1 @@ -54,24 +54,24 @@ else exit 1 fi -url='https://github.com/fnproject/fn/cli/releases/download' +url='https://github.com/fnproject/cli/releases/download' # perform some very rudimentary platform detection case "$(uname)" in Linux) - $sh_c "$curl /usr/local/bin/fn $url/$release/fn_linux" + $sh_c "$curl /usr/local/bin/fn $url/$version/fn_linux" $sh_c "chmod +x /usr/local/bin/fn" fn --version exit 0 ;; Darwin) - $sh_c "$curl /usr/local/bin/fn $url/$release/fn_mac" + $sh_c "$curl /usr/local/bin/fn $url/$version/fn_mac" $sh_c "chmod +x /usr/local/bin/fn" fn --version exit 0 ;; WindowsNT) - $sh_c "$curl $url/$release/fn.exe" + $sh_c "$curl $url/$version/fn.exe" # TODO how to make executable? chmod? fn.exe --version exit 0