Update READEME link and add back the basic usage (#1366)

This commit is contained in:
Ta-Ching Chen
2019-10-31 11:14:04 +08:00
committed by GitHub
parent e22cdee5f5
commit fc1aab2472
+42 -19
View File
@@ -1,5 +1,5 @@
Fission: Serverless Functions for Kubernetes # Fission: Serverless Functions for Kubernetes
============================================
[![Build Status](https://travis-ci.org/fission/fission.svg?branch=master)](https://travis-ci.org/fission/fission) [![Build Status](https://travis-ci.org/fission/fission.svg?branch=master)](https://travis-ci.org/fission/fission)
[![Go Report Card](https://goreportcard.com/badge/github.com/fission/fission)](https://goreportcard.com/report/github.com/fission/fission) [![Go Report Card](https://goreportcard.com/badge/github.com/fission/fission)](https://goreportcard.com/report/github.com/fission/fission)
[![Fission Slack](http://slack.fission.io/badge.svg)](http://slack.fission.io) [![Fission Slack](http://slack.fission.io/badge.svg)](http://slack.fission.io)
@@ -18,7 +18,7 @@ language-specific parts are isolated in something called
_environments_ (more below). Fission currently supports NodeJS, Python, Ruby, Go, _environments_ (more below). Fission currently supports NodeJS, Python, Ruby, Go,
PHP, Bash, and any Linux executable, with more languages coming soon. PHP, Bash, and any Linux executable, with more languages coming soon.
### Performance: 100msec cold start # Performance: 100msec cold start
Fission maintains a pool of "warm" containers that each contain a Fission maintains a pool of "warm" containers that each contain a
small dynamic loader. When a function is first called, small dynamic loader. When a function is first called,
@@ -26,7 +26,7 @@ i.e. "cold-started", a running container is chosen and the function is
loaded. This pool is what makes Fission fast: cold-start latencies loaded. This pool is what makes Fission fast: cold-start latencies
are typically about 100msec. are typically about 100msec.
### Kubernetes is the right place for Serverless # Kubernetes is the right place for Serverless
We're built on Kubernetes because we think any non-trivial app will We're built on Kubernetes because we think any non-trivial app will
use a combination of serverless functions and more conventional use a combination of serverless functions and more conventional
@@ -37,30 +37,53 @@ Building on Kubernetes also means that anything you do for operations
on your Kubernetes cluster — such as monitoring or log on your Kubernetes cluster — such as monitoring or log
aggregation — also helps with ops on your Fission deployment. aggregation — also helps with ops on your Fission deployment.
Getting started and documentation # Getting started and documentation
===============================
You can learn more about Fission and get started from [Fission Docs](https://docs.fission.io). ## Fission Concepts
* See the [installation guide](https://docs.fission.io/installation/) for installing and running Fission.
* See the [troubleshooting guide](https://docs.fission.io/trouble-shooting/) for debugging your functions and Fission installation.
Contributing Visit [concepts](https://docs.fission.io/docs/concepts/) for more details.
=================
### Building Fission ## Documentations
See the [compilation guide](https://docs.fission.io/contributing/).
### Contact You can learn more about Fission and get started from [Fission Docs](https://docs.fission.io/docs).
Reach us on [slack](http://slack.fission.io) or * See the [installation guide](https://docs.fission.io/docs/installation/) for installing and running Fission.
[twitter](https://twitter.com/fissionio). * See the [troubleshooting guide](https://docs.fission.io/docs/trouble-shooting/) for debugging your functions and Fission installation.
## Usage
```bash
# Add the stock NodeJS env to your Fission deployment
$ fission env create --name nodejs --image fission/node-env
# A javascript one-liner that prints "hello world"
$ curl https://raw.githubusercontent.com/fission/fission/master/examples/nodejs/hello.js > hello.js
# Upload your function code to fission
$ fission function create --name hello --env nodejs --code hello.js
# Map GET /hello to your new function
$ fission route create --method GET --url /hello --function hello
# Run the function. This takes about 100msec the first time.
$ fission function test --name hello
Hello, world!
```
# Contributing
## Building Fission
See the [compilation guide](https://docs.fission.io/docs/contributing/).
## Contact
Reach us on [slack](http://slack.fission.io) or [twitter](https://twitter.com/fissionio).
Fission is a project by [many contributors](https://github.com/fission/fission/graphs/contributors). Fission is a project by [many contributors](https://github.com/fission/fission/graphs/contributors).
### Community meeting ## Community meeting
A regular community meeting takes place every other Thursday at 08:30 AM PT (Pacific Time). [Convert to your local timezone](http://www.thetimezoneconverter.com/?t=08:30&tz=PT%20%28Pacific%20Time%29). A regular community meeting takes place every other Thursday at 08:30 AM PT (Pacific Time). [Convert to your local timezone](http://www.thetimezoneconverter.com/?t=08:30&tz=PT%20%28Pacific%20Time%29).
## Official Releases # Official Releases
Official releases of Fission can be found on [the releases page](https://github.com/fission/fission/releases). Official releases of Fission can be found on [the releases page](https://github.com/fission/fission/releases).
Please note that it is strongly recommended that you use official releases of Fission, as unreleased versions from Please note that it is strongly recommended that you use official releases of Fission, as unreleased versions from
@@ -68,6 +91,6 @@ the master branch are subject to changes and incompatibilities that will not be
Builds from the master branch can have functionality changed and even removed at any time without compatibility support Builds from the master branch can have functionality changed and even removed at any time without compatibility support
and without prior notice. and without prior notice.
## Licensing # Licensing
Fission is under the Apache 2.0 license. Fission is under the Apache 2.0 license.