Skip to content

Commit

Permalink
Merge pull request Kong#188 from Mashape/document/readme
Browse files Browse the repository at this point in the history
Document/readme
  • Loading branch information
Montana Flynn committed Apr 30, 2015
2 parents 5de00b9 + 80fc2bc commit 04a407d
Showing 1 changed file with 32 additions and 21 deletions.
53 changes: 32 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
# KONG: The API Management Layer
# KONG: Microservice Management Layer

[![Build Status][travis-badge]][travis-url]
[![License Badge][license-badge]][license-url]
[![Gitter Badge][gitter-badge]][gitter-url]

- Website: [getkong.org](http://getkong.org/)
- Docs: [getkong.org/docs](http://getkong.org/docs)
- Mailing List: [Google Groups](https://groups.google.com/forum/#!forum/konglayer)
- Gitter Chat: [mashape/kong](https://gitter.im/Mashape/kong)
- Website: [getkong.org][kong-url]
- Docs: [getkong.org/docs][kong-docs]
- Mailing List: [Google Groups][google-groups-url]

Kong was built for securing, managing and extending APIs & Microservices. If you're building for web, mobile or IoT (Internet of Things) you will likely end up needing to implement common functionality on top of your actual software. Kong can help by acting as a gateway for any HTTP resource while providing logging, authentication and other functionality through plugins.
[![][kong-logo]][kong-url]

Kong was built to secure, manage and extend Microservices & APIs. If you're building for web, mobile or IoT (Internet of Things) you will likely end up needing to implement common functionality on top of your actual software. Kong can help by acting as a gateway for any HTTP resource while providing logging, authentication and other functionality through plugins.

Powered by NGINX and Cassandra with a focus on high performance and reliability, Kong runs in production at [Mashape][mashape-url] where it has handled billions of API requests for over ten thousand APIs.

## Core Features

Expand All @@ -19,27 +22,14 @@ Kong was built for securing, managing and extending APIs & Microservices. If you
- **Performance**: Kong handles load with ease by scaling and using NGINX at the core.
- **Plugins**: Extendable architecture for adding functionality to Kong and APIs.
- **Logging**: Log requests and responses to your system over TCP, UDP or to disk.
- **Monitoring**: Live monitoring provides key load and performance server metrics
- **Monitoring**: Live monitoring provides key load and performance server metrics.
- **Authentication**: Manage consumer credentials query string and header tokens.
- **Rate-limiting**: Block and throttle requests based on IP or authentication.
- **Transformations**: Add, remove or manipulate HTTP params and headers on-the-fly.
- **CORS**: Enable cross-origin requests to your APIs that would otherwise be blocked.
- **Anything**: Need custom functionality? Extend Kong with your own Lua plugins!


Powered by NGINX and Cassandra with a focus on high performance and reliability, Kong runs in production at [Mashape](https://www.mashape.com) where it has handled billions of API requests for over ten thousand APIs.

[![](http://i.imgur.com/fxkvt5k.png)](http://getkong.org/)

## Documentation

Full versioned documentation is available at [GetKong.org](http://getkong.org):

- [Installation](http://www.getkong.org/download)
- [Quick Start](http://getkong.org/docs/latest/getting-started/quickstart/)
- [CLI Reference](http://getkong.org/docs/latest/cli/)
- [API Reference](http://getkong.org/docs/latest/admin-api)
- [Configuration](http://getkong.org/docs/latest/configuration/)
[![][kong-benefits]][kong-url]

## Benchmarks

Expand All @@ -63,6 +53,17 @@ After adding the `target_url` into the Kong instance we load tested while rampin

![](http://i.imgur.com/aDGRe4G.png)

## Documentation

Full versioned documentation is available at [GetKong.org][kong-url]:

- [Latest Docs](http://www.getkong.org/docs/)
- [Installation](http://www.getkong.org/download)
- [Quick Start](http://getkong.org/docs/latest/getting-started/quickstart/)
- [CLI Reference](http://getkong.org/docs/latest/cli/)
- [API Reference](http://getkong.org/docs/latest/admin-api)
- [Configuration](http://getkong.org/docs/latest/configuration/)

## Development

Please see the [CONTRIBUTING.md][kong-contrib] if you would like to have your changes merged into Kong.
Expand Down Expand Up @@ -111,9 +112,17 @@ When developing, use the `Makefile` for doing the following operations:

Kong is provided under the [MIT License][license-url].

[kong-url]: http://getkong.org/
[kong-docs]: http://getkong.org/docs/

[kong-contrib]: https://github.com/Mashape/kong/blob/master/CONTRIBUTING.md
[kong-changelog]: https://github.com/Mashape/kong/blob/master/CHANGELOG.md

[kong-logo]: http://i.imgur.com/4jyQQAZ.png
[kong-benefits]: http://i.imgur.com/2hg4orF.png

[mashape-url]: https://www.mashape.com

[travis-url]: https://travis-ci.org/Mashape/kong
[travis-badge]: https://img.shields.io/travis/Mashape/kong.svg?style=flat

Expand All @@ -122,3 +131,5 @@ Kong is provided under the [MIT License][license-url].

[gitter-url]: https://gitter.im/Mashape/kong
[gitter-badge]: https://img.shields.io/badge/Gitter-Join%20Chat-blue.svg

[google-groups-url]: https://groups.google.com/forum/#!forum/konglayer

0 comments on commit 04a407d

Please sign in to comment.