influxdb/README.md

40 lines
1.9 KiB
Markdown
Raw Normal View History

InfluxDB [![Build Status](https://travis-ci.org/influxdb/influxdb.png?branch=master)](https://travis-ci.org/influxdb/influxdb)
2013-09-26 14:31:11 +00:00
=========
2014-11-17 23:56:35 +00:00
> NOTE: The master branch of InfluxDB is undergoing a significant refactor for
> v0.9.0. If you need to build a working copy of InfluxDB, please use the
> [`0.8.6`](https://github.com/influxdb/influxdb/releases/tag/v0.8.6) tag.
InfluxDB is an open source **distributed time series database** with
**no external dependencies**. It's useful for recording metrics,
events, and performing analytics.
2013-09-27 16:37:19 +00:00
It has a built-in HTTP API so you don't have to write any server side
code to get up and running.
2013-09-27 16:37:19 +00:00
InfluxDB is designed to be scalable, simple to install and manage, and
fast to get data in and out.
2013-09-30 15:03:05 +00:00
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/docs/v0.7/introduction/overview.html).
* Follow the [getting started guide](http://influxdb.org/docs/v0.7/introduction/getting_started.html) 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.com/docs/v0.7/client_libraries/javascript.html),
or check out the
[HTTP API documentation to start writing a library for your favorite language](http://influxdb.org/docs/v0.7/api/reading_and_writing_data.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/docs/v0.7/introduction/installation.html). 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
2014-07-15 16:52:17 +00:00
[follow along on our docs](http://github.com/influxdb/influxdb/blob/master/docs/contributing.md)