featurebase/README.md
2017-05-01 14:04:36 -05:00

64 lines
1.9 KiB
Markdown

<a href="https://www.pilosa.com">
<img src="https://www.pilosa.com/img/logo.svg" width="50%">
</a>
[![Build Status](https://travis-ci.com/pilosa/pilosa.svg?token=Peb4jvQ3kLbjUEhpU5aR&branch=master)](https://travis-ci.com/pilosa/pilosa)
## An open source, distributed bitmap index.
- [Docs](#docs)
- [Getting Started](#getting-started)
- [Data Model](#data-model)
- [Query Language](#query-language)
- [Client Libraries](#client-drivers)
- [Get Support](#get-support)
- [Contributing](#contributing)
## Docs
See our [Documentation](https://www.pilosa.com/docs/) for information about installing and working with Pilosa.
## Getting Started
1. [Install Pilosa](https://www.pilosa.com/docs/installation/).
2. [Start Pilosa](https://www.pilosa.com/docs/getting-started/#starting-pilosa) with the default configuration:
```shell
pilosa server
```
and verify that it's running:
```shell
curl localhost:10101/nodes
```
3. Follow along with the [Sample Project](https://www.pilosa.com/docs/getting-started/#sample-project) to get a better understanding of Pilosa's capabilities.
## Data Model
Check out how the Pilosa [Data Model](https://www.pilosa.com/docs/data-model/) works.
## Query Language
You can interact with Pilosa directly in the console using the [Pilosa Query Language](https://www.pilosa.com/docs/query-language/) (PQL).
## Client Libraries
There are supported libraries for the following languages:
- [Go](https://www.pilosa.com/docs/client-libraries/#go)
- [Java](https://www.pilosa.com/docs/client-libraries/#java)
- [Python](https://www.pilosa.com/docs/client-libraries/#python)
## Get Support
There are [several channels](https://www.pilosa.com/community/#support) available for you to reach out to us for support.
## Contributing
Pilosa is an open source project. Please see our [Contributing Guide](https://www.pilosa.com/docs/contributing/) for information about how to get involved.