druid/README.md

71 lines
3.9 KiB
Markdown
Raw Normal View History

<!--
~ Licensed to the Apache Software Foundation (ASF) under one
~ or more contributor license agreements. See the NOTICE file
~ distributed with this work for additional information
~ regarding copyright ownership. The ASF licenses this file
~ to you under the Apache License, Version 2.0 (the
~ "License"); you may not use this file except in compliance
~ with the License. You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing,
~ software distributed under the License is distributed on an
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~ KIND, either express or implied. See the License for the
~ specific language governing permissions and limitations
~ under the License.
-->
[![Slack](https://img.shields.io/badge/slack-%23druid-72eff8?logo=slack)](https://druid.apache.org/community/join-slack)
[![Build Status](https://travis-ci.org/apache/incubator-druid.svg?branch=master)](https://travis-ci.org/apache/incubator-druid)
2019-08-21 00:20:19 -04:00
[![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/apache/incubator-druid.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/apache/incubator-druid/context:java)
[![Coverage Status](https://img.shields.io/codecov/c/gh/apache/incubator-druid)](https://codecov.io/gh/apache/incubator-druid)
2019-08-26 22:04:51 -04:00
[![Docker](https://img.shields.io/badge/container-docker-blue.svg)](https://hub.docker.com/r/apache/incubator-druid)
<!--- Following badges are disabled until they can be fixed: -->
<!--- [![Inspections Status](https://img.shields.io/teamcity/http/teamcity.jetbrains.com/s/OpenSourceProjects_Druid_Inspections.svg?label=TeamCity%20inspections)](https://teamcity.jetbrains.com/viewType.html?buildTypeId=OpenSourceProjects_Druid_Inspections) -->
2015-02-18 19:50:18 -05:00
## Apache Druid (incubating)
2014-08-01 16:24:12 -04:00
Apache Druid (incubating) is a high performance analytics data store for event-driven data.
2015-02-18 19:50:18 -05:00
*Disclaimer: Apache Druid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.*
2014-08-01 16:24:12 -04:00
2019-08-22 12:50:55 -04:00
### Getting Started
2015-02-18 19:50:18 -05:00
2019-08-22 12:50:55 -04:00
You can get started with Druid with our [quickstart](https://druid.apache.org/docs/latest/tutorials/quickstart.html).
2014-08-01 16:24:12 -04:00
### Documentation
2015-02-18 19:50:18 -05:00
You can find the [documentation for the latest Druid release](https://druid.apache.org/docs/latest/) on
2019-08-22 12:50:55 -04:00
the [project website](https://druid.apache.org).
2015-02-18 19:50:18 -05:00
If you would like to contribute documentation, please do so under
2019-08-22 12:50:55 -04:00
`/docs` in this repository and submit a pull request.
2015-02-18 19:50:18 -05:00
### Community
Community support is available on the
2019-08-22 12:50:55 -04:00
[druid-user mailing list](https://groups.google.com/forum/#!forum/druid-user), which
is hosted at Google Groups.
Development discussions occur on [dev@druid.apache.org](https://lists.apache.org/list.html?dev@druid.apache.org), which
you can subscribe to by emailing [dev-subscribe@druid.apache.org](mailto:dev-subscribe@druid.apache.org).
2014-08-08 14:41:26 -04:00
2019-08-08 12:15:27 -04:00
Some committers and users are present in the channel `#druid` on the Apache Slack team. Please use our [invitation link to join](https://druid.apache.org/community/join-slack), and once you join, add the `#druid` channel.
### Building From Source
2019-03-18 17:16:21 -04:00
Please note that JDK 8 is required to build Druid.
For instructions on building Druid from source, see [docs/development/build.md](docs/development/build.md)
2016-04-13 14:33:31 -04:00
### Contributing
2019-08-22 12:50:55 -04:00
Please follow the [community guidelines](https://druid.apache.org/community/) for contributing.
### License
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)