diff --git a/README.md b/README.md index 51df854010..5a29cd9323 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,46 @@ -# GreptimeDB +

+ GreptimeDB Logo +

-[![codecov](https://codecov.io/gh/GrepTimeTeam/greptimedb/branch/develop/graph/badge.svg?token=FITFDI3J3C)](https://codecov.io/gh/GrepTimeTeam/greptimedb) +

+ The next-generation hybrid timeseries/analytics processing database in the cloud +

-GreptimeDB: the next-generation hybrid timeseries/analytics processing database in the cloud. +

+ +   + CI +   + +

+ +

+ +   + +

+ +## What is GreptimeDB + +GreptimeDB is an open-source time-series database with special focus on +scalability, analytical capabilities and efficiency. It's designed to work on +infrastructure of cloud era, and benefits from its elasticity and commodity +storage. + +The core developers of GreptimeDB have been building time-series data platform +for years. Based on their best-practices, GreptimeDB is born to give you: + +- A standalone binary that scales to highly-available distributed cluster, with transparent experience from user's perspective +- Columnar data layout optimised for time-series, compacted, compressed, stored on various storage backends +- Flexible index options, tackling high cardinality issues down +- Distributed parallel query execution, leveraging elastic computing resource +- Native SQL, and Python scripting for advanced analytical scenarios +- Widely adopted database protocols and APIs +- Extensible table engine architecture for extensive workloads ## Getting Started -### Prerequisites +### Prerequisite To compile GreptimeDB from source, you'll need the following: - Rust @@ -116,6 +150,35 @@ CREATE DATABASE hello_greptime; ``` You can delete your data by removing `/tmp/greptimedb`. +# Community + +The core team will be thrilled if you participate in any way you like. When you are stuck, try +asking for help by filing an issue with a detailed description of what you were trying to do +and what went wrong. If you have any questions or if you would like to get involved in our +community, please check out: + +- GreptimeDB Community on [Slack](https://greptime.com/slack) +- GreptimeDB GitHub [Discussions](https://github.com/GreptimeTeam/greptimedb/discussions) +- Greptime official [Website](https://greptime.com) + +In addition, you may: + +- View our official [Blog](https://greptime.com/blog) +- Connect us with [Linkedin](https://www.linkedin.com/company/greptime/) +- Follow us on [Twitter](https://twitter.com/greptime) + +## Documentation + +- GreptimeDB [User Guide](https://greptime.com/docs/user-guide) +- GreptimeDB [Developer Guide](https://greptime.com/docs/developer-guide) + +## License + +GreptimeDB uses the [Apache 2.0 license][1] to strike a balance between +open contributions and allowing you to use the software however you want. + +[1]: + ## Contributing Please refer to [contribution guidelines](CONTRIBUTING.md) for more information. diff --git a/docs/logo-text-padding.png b/docs/logo-text-padding.png new file mode 100755 index 0000000000..ebe53a2858 Binary files /dev/null and b/docs/logo-text-padding.png differ