riff

README

= riff is for functions image:https://travis-ci.org/projectriff/riff.svg?branch=master["Build Status", link="https://travis-ci.org/projectriff/riff"]

image::logo.png[riff logo, link=https://projectriff.io/]
= A FaaS for Kubernetes

The riff project builds on top of the link:https://github.com/knative/[Knative] project's build, serving and eventing features.

== Installation of the latest release

Official binary release are avilable from the link:https://github.com/projectriff/riff/releases[Releases] page.

See link:https://projectriff.io/docs/getting-started-with-knative-riff-on-minikube/[Getting started on Minikube] or
link:https://projectriff.io/docs/getting-started-with-knative-riff-on-gke/[Getting started on GKE] for how to install the riff CLI and the riff system.

=== Community releases

NOTE: Community releases are not created, managed or monitored by the riff team.

To install the `riff` CLI for MacOS with Homebrew:

[source, bash]
----
brew install starkandwayne/cf/riff
----

To install the CLI for Debian/Ubuntu Linux:

[source, bash]
----
wget -q -O - https://raw.githubusercontent.com/starkandwayne/homebrew-cf/master/public.key | apt-key add -
echo "deb http://apt.starkandwayne.com stable main" | tee /etc/apt/sources.list.d/starkandwayne.list
apt-get update
apt-get install riff
----

== Developer installation of Knative

See link:https://github.com/knative/eventing/blob/master/DEVELOPMENT.md[Development] to install the Knative Build, Serving and Eventing projects.

== [[manual]] Manual build of the riff CLI

This is the best option if you want to modify the riff CLI.

=== Prerequisites

You need:

* A working Go environment

=== Get the main riff repo

[source, bash]
----
go get -d github.com/projectriff/riff/...
----

=== Build the riff CLI

[source, bash]
----
cd $(go env GOPATH)/src/github.com/projectriff/riff
make build
----

=== Build and install the riff CLI

[source, bash]
----
cd $(go env GOPATH)/src/github.com/projectriff/riff
make build install
----
NOTE: This installs the CLI in `$GOBIN`, or if that is not set, in the `bin` subdirectory of the directory specified in `$GOPATH`.

== Contributing to riff

Please refer to the link:CONTRIBUTING.adoc[Contributors' Guide].

== Maintaining riff

Please refer to the link:MAINTAINING.adoc[Maintainers' Guide].