You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(README): restructure for clarity, SEO, and accuracy (#27342)
* docs(README): restructure for clarity, SEO, and accuracy
- Add H1 heading, tagline, and descriptive alt text for SEO and accessibility
- Standardize product name to "InfluxDB 3 Core" throughout
- Fix typo "Compatability" → "Compatibility"
- Remove stale link to v1 getting started guide
- Add "Other InfluxDB Versions" table cross-referencing main, main-2.x, and
master-1.x branches with query languages and documentation links
- Add technical summary block (storage format, query languages, write
format, API port, tech stack, compatibility) after feature highlights
- Replace time-sensitive release cadence in Project Status with durable
links to v3.* tags and docs release notes
- Reorder installation list to lead with v3 Core and Enterprise
- Trim installation description to remove v1/v2 CLI references
- Remove outdated "Learn InfluxDB" section including stale Cloud CTA
- Add Support section linking to feedback channels in docs
- Add License and Discord badges (brand-colored static shields)
Release badge and "Releases" terminology intentionally omitted: GitHub
Releases are not kept in sync with tags for this repository. Revisit
once Releases are published alongside tags.
* docs(README): Update README.md
InfluxDB Core is a database built to collect, process, transform, and store event and time series data. It is ideal for use cases that require real-time ingest and fast query response times to build user interfaces, monitoring, and automation solutions.
15
+
InfluxDB 3 Core is a database built to collect, process, transform, and store event and time series data. It is ideal for use cases that require real-time ingest and fast query response times to build user interfaces, monitoring, and automation solutions.
- Compatibility with InfluxDB 1.x and 2.x write APIs
31
-
-Compatability with InfluxDB 1.x query API (InfluxQL)
36
+
-Compatibility with InfluxDB 1.x query API (InfluxQL)
32
37
- SQL query engine with support for FlightSQL and HTTP query API
33
38
34
-
## Project Status
39
+
**Storage format:** Apache Parquet on object storage (S3, Azure, GCP) or local disk\
40
+
**Query languages:** SQL, InfluxQL, Flight SQL\
41
+
**Write format:** Line protocol\
42
+
**API:** HTTP on port 8181\
43
+
**Built with:** Rust, Apache Arrow, DataFusion\
44
+
**Compatible with:** InfluxDB 1.x and 2.x write APIs, InfluxDB 1.x query API (InfluxQL)
35
45
36
-
InfluxDB 3 Core is GA as of April 15, 2025! We plan to have monthly point releases for the following six months, with patch releases as needed. We will move to a quarterly cadence after that for 3-4 releases, after which we'll reevaluate our release schedule.
46
+
## Other InfluxDB Versions
37
47
38
-
Join the [InfluxDB3 Discord](https://discord.gg/vZe2w2Ds8B)
39
-
or the public channels below to share your feedback, feature requests, and bug reports.
48
+
This repository contains multiple InfluxDB versions on separate branches:
40
49
41
-
See the [InfluxDB 3 Core & Enterprise GA release announcement here](https://www.influxdata.com/blog/influxdb-3-oss-ga/)
42
-
or dig into the [InfluxDB 3 getting started guide here](https://docs.influxdata.com/influxdb3/core/get-started/).
50
+
| Version | Branch | Query Languages | Documentation |
Try **InfluxDB Cloud** for free and get started fast with no local setup required. Click [here](https://cloud2.influxdata.com/signup) to start building your application on InfluxDB Cloud.
58
+
InfluxDB 3 Core has been [generally available since April 2025](https://www.influxdata.com/blog/influxdb-3-oss-ga/). See [`v3.*` tags](https://github.com/influxdata/influxdb/tags) and [release notes](https://docs.influxdata.com/influxdb3/core/release-notes/) for the latest version.
48
59
60
+
Join the [InfluxDB3 Discord](https://discord.gg/vZe2w2Ds8B) or the public channels below to share your feedback, feature requests, and bug reports.
49
61
50
62
## Installation
51
-
We have nightly and versioned Docker images, Debian packages, RPM packages, and tarballs of InfluxDB available on the [InfluxData downloads page](https://portal.influxdata.com/downloads/). We also provide the InfluxDB command line interface (CLI) client as a separate binary available at the same location.
63
+
Docker images, Debian packages, RPM packages, and tarballs are available on the [InfluxData downloads page](https://portal.influxdata.com/downloads/).
52
64
53
-
- For v1 installation, use the [main 1.x branch](https://github.com/influxdata/influxdb/tree/master-1.x) or [install InfluxDB OSS directly](https://docs.influxdata.com/influxdb/v1/introduction/install/#installing-influxdb-oss).
54
-
- For v2 installation, use the [main 2.x branch](https://github.com/influxdata/influxdb/tree/main-2.x).
55
-
- For InfluxDB 3 Core see the [InfluxDB 3 Core getting started guide](https://docs.influxdata.com/influxdb3/core/get-started/).
56
-
- For InfluxDB 3 Enterprise see the [InfluxDB 3 Enterprise getting started guide](https://docs.influxdata.com/influxdb3/enterprise/get-started/).
65
+
- For InfluxDB 3 Core, see the [getting started guide](https://docs.influxdata.com/influxdb3/core/get-started/).
66
+
- For InfluxDB 3 Enterprise, see the [getting started guide](https://docs.influxdata.com/influxdb3/enterprise/get-started/).
67
+
- For v2.x, see the [`main-2.x` branch](https://github.com/influxdata/influxdb/tree/main-2.x).
68
+
- For v1.x, see the [`master-1.x` branch](https://github.com/influxdata/influxdb/tree/master-1.x).
57
69
58
70
If you are interested in building from source, see the [building from source](CONTRIBUTING.md#building-from-source) guide for contributors.
59
71
60
-
To begin using InfluxDB, visit our [Getting Started with InfluxDB](https://docs.influxdata.com/influxdb/v1/introduction/get-started/) documentation.
61
72
73
+
## Support
74
+
75
+
For community support and feedback channels, see [Bug reports and feedback](https://docs.influxdata.com/influxdb3/core/#bug-reports-and-feedback).
62
76
63
77
## License
64
-
The open source software we build is licensed under the permissive MIT or Apache 2 licenses at the user's choosing. We’ve long held the view that our open source code should be truly open and our commercial code should be separate and closed.
78
+
The open source software we build is licensed under the permissive MIT or Apache 2 licenses at the user’s choosing. We’ve long held the view that our open source code should be truly open and our commercial code should be separate and closed.
65
79
66
80
67
81
## Interested in joining the team building InfluxDB?
0 commit comments