diff --git a/README.md b/README.md index 157fcbea6..b9a298b6e 100644 --- a/README.md +++ b/README.md @@ -1,80 +1,70 @@

-Logo +Logo +

+

+ + +License +Downloads

- dbt-native data observability for analytics & data engineers +Elementary OSS: dbt-native data observability

-

- - -License -Downloads -

-⭐️ Star the repo ⭐ - -[Demo »](https://bit.ly/3IAp9wf) | [Docs »](https://docs.elementary-data.com/) | [Slack »](https://www.elementary-data.com/community) +[Docs »](https://docs.elementary-data.com/) | [Join the Elementary Community »](https://www.elementary-data.com/community)
+
+ ⭐️ Star the repo +
+
-## What is Elementary? - -Elementary is a dbt-native data observability solution for data and analytics engineers. -Set up in minutes, gain immediate visibility, detect data issues, send actionable alerts, and understand impact and root cause. -Elementary has two offerings: an open-source package and managed platform. +**Built by the [Elementary](https://www.elementary-data.com) team, helping you deliver trusted data in the AI era.** - - - +Elementary OSS is the open-source CLI for dbt-native data observability. It works with the [Elementary dbt package](https://github.com/elementary-data/dbt-data-reliability) to generate the basic Elementary observability report and send alerts to Slack and Microsoft Teams. -
+For teams that need data reliability at scale, we offer **[Elementary Cloud](https://www.elementary-data.com/)**, a full Data & AI Control Plane with automated ML monitoring, column-level lineage from source to BI, a built-in catalog, and AI agents that scale reliability workflows for both engineers and business users. -## Open-source Package vs. Cloud Platform +![Demo](static/newreadmedemo.gif) -### Elementary Cloud Platform +## How It Works -Ideal for teams monitoring mission-critical data pipelines, requiring guaranteed uptime and reliability, short-time-to-value, advanced features, collaboration, and professional support. -The solution is secure by design, and requires no access to your data from cloud. +Elementary OSS connects to your warehouse and reads the metadata, artifacts, and test results collected by the Elementary dbt package. +With this information, it can: -[Get started with Elementary Cloud](https://docs.elementary-data.com/quickstart) +- Generate a data observability report +- Surface anomalies and failed tests +- Send alerts to Slack and Teams +- Track model and test performance trends -### Open-source Package +## Quickstart -Elementary Community is an open-source CLI tool you can deploy and orchestrate to send Slack alerts and self-host the Elementary report. It is best for data and analytics engineers that require basic observability capabilities. +Follow the quickstart guide to install and configure the Elementary dbt package and CLI: -[Get started with the Open-source Package](https://docs.elementary-data.com/oss/oss-introduction) +👉 https://docs.elementary-data.com/oss/quickstart ## Features -**Anomaly detection tests** - Collect data quality metrics and detect anomalies, as native dbt tests. - -**Automated monitors** - Out-of-the-box cloud monitors to detect freshness, volume and schema issues. - -**End-to-End Data Lineage** - Enriched with the latest test results, for impact and root cause analysis of data issues. Elementary Cloud offers **Column Level Lineage** and **BI integrations**. - -**Data quality dashboard** - Single interface for all your data monitoring and test results. - -**Models performance** - Monitor models and jobs run results and performance over time. - -**Configuration-as-code** - Elementary configuration is managed in your dbt code. - -**Alerts** - Actionable alerts including custom channels and tagging of owners. - -**Data catalog** - Explore your datasets information - descriptions, columns, datasets health, etc. - -**dbt artifacts uploader** - Save metadata and run results as part of your dbt runs. - -**AI-Powered Data Tests & Unstructured Data Validations** - Validate and monitor data using AI powered tests to validate both structured and unstructured data +- **Anomaly detection tests** - Collect data quality metrics and detect anomalies, as native dbt tests. +- **Automated monitors** - Out-of-the-box cloud monitors to detect freshness, volume and schema issues. +- **End-to-End Data Lineage** - Enriched with the latest test results, for impact and root cause analysis of data issues. Elementary Cloud offers **Column-Level-Lineage from ingestion to BI**. +- **Data quality dashboard** - Single interface for all your data monitoring and test results. +- **Models performance** - Monitor models and jobs run results and performance over time. +- **Configuration-as-code** - Elementary configuration is managed in your dbt code. +- **Alerts** - Actionable alerts including custom channels and tagging of owners. +- **Data catalog** - Explore your datasets information - descriptions, columns, datasets health, etc. +- **dbt artifacts uploader** - Save metadata and run results as part of your dbt runs. +- **AI-Powered Data Tests & Unstructured Data Validations** - Validate and monitor data using AI powered tests to validate both structured and unstructured data ## Support -For additional information and help, you can use one of these channels: +For additional information and help: -- [Slack community](https://www.elementary-data.com/community) \(Release announcements, community support, discussions, etc.\) -- [GitHub issues](https://github.com/elementary-data/elementary/issues) \(Bug reports, feature requests) +- [Join thousands of users in the Slack community](https://www.elementary-data.com/community) \(Release announcements, community and AI support, discussions, etc.\) +- [Open a GitHub issue](https://github.com/elementary-data/elementary/issues) \(Bug reports, feature requests) - Check out the [contributions guide](./CONTRIBUTING.md) and [open issues](https://github.com/elementary-data/elementary/issues). ## diff --git a/static/demoreadme.gif b/static/demoreadme.gif new file mode 100644 index 000000000..9ee205610 Binary files /dev/null and b/static/demoreadme.gif differ diff --git a/static/newreadmedemo.gif b/static/newreadmedemo.gif new file mode 100644 index 000000000..15f1685a3 Binary files /dev/null and b/static/newreadmedemo.gif differ