Influxdata
/
influxdb
mirror of https://github.com/influxdata/influxdb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix the build instructions link and format the readme

pull/567/head
John Shahid 2014-05-21 12:22:21 -04:00
parent e6c828f4e7
commit 5b984c1252
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,21 +1,35 @@
InfluxDB [![Build Status](https://travis-ci.org/influxdb/influxdb.png?branch=master)](https://travis-ci.org/influxdb/influxdb)
=========
InfluxDB is an open source **distributed time series database** with **no external dependencies**. It's useful for recording metrics, events, and performing analytics.
InfluxDB is an open source **distributed time series database** with
**no external dependencies**. It's useful for recording metrics,
events, and performing analytics.
It has a built-in HTTP API so you don't have to write any server side code to get up and running.
It has a built-in HTTP API so you don't have to write any server side
code to get up and running.
InfluxDB is designed to be scalable, simple to install and manage, and fast to get data in and out.
InfluxDB is designed to be scalable, simple to install and manage, and
fast to get data in and out.
It aims to answer queries in real-time. That means every data point is indexed as it comes in and is immediately available in queries that should return in < 100ms.
It aims to answer queries in real-time. That means every data point is
indexed as it comes in and is immediately available in queries that
should return in < 100ms.
## Quickstart
* Understand the [design goals and motivations of the project](http://influxdb.org/overview/).
* Follow the [getting started guide](http://influxdb.org/docs/) to find out how to install InfluxDB, start writing data, and issue queries - in just a few minutes.
* See the [list of libraries for different languages](http://influxdb.org/docs/libraries/javascript.html), or check out the [HTTP API documentation to start writing a library for your favorite language](http://influxdb.org/docs/api/http.html).
* See the
[list of libraries for different languages](http://influxdb.org/docs/libraries/javascript.html),
or check out the
[HTTP API documentation to start writing a library for your favorite language](http://influxdb.org/docs/api/http.html).
## Building
You don't need to build the project to use it. Pre-built [binaries and instructions to install InfluxDB are here](http://influxdb.org/download/). That's the recommended way to get it running. However, if you want to contribute to the core of InfluxDB, you'll need to build. For those adventurous enough, you can [follow along on our docs](http://influxdb.org/docs/getting_started/building.html).
You don't need to build the project to use it. Pre-built
[binaries and instructions to install InfluxDB are here](http://influxdb.org/download/). That's
the recommended way to get it running. However, if you want to
contribute to the core of InfluxDB, you'll need to build. For those
adventurous enough, you can
[follow along on our docs](http://influxdb.org/docs/v0.6/introduction/getting_started.html).