diff --git a/README.md b/README.md index 8e1abe45d..cd335c115 100644 --- a/README.md +++ b/README.md @@ -15,12 +15,40 @@ For reporting issues, feature requests and contributions, refer to [issues](http ## Quick start -After adding the package to `packages.yml` and running `dbt deps`, add to your ```dbt_project.yml```: + +Add to your `packages.yml` according to your dbt version: + +#### For dbt 1.2.0 and above: + +```yml +packages: + - package: elementary-data/elementary + version: 0.4.10 + ## compatible with Elementary CLI version 0.4.10 + ## see docs: https://docs.elementary-data.com/ +``` + +#### For dbt >=1.0.0 <1.2.0: + +```yml +packages: + - package: elementary-data/elementary + version: 0.4.10 + ## compatible with Elementary CLI version 0.4.10 + ## see docs: https://docs.elementary-data.com/ + + ## !! Important !! For dbt <1.2.0 only + ## (Prevents dbt_utils versions exceptions) + - package: dbt-labs/dbt_utils + version: [">=0.8.0", "<0.9.0"] +``` + +After adding to `packages.yml` and running `dbt deps`, add to your ```dbt_project.yml```: ```yml models: ## elementary models will be created in the schema '_elementary' -## see docs: https://docs.elementary-data.com/ +## for details, see docs: https://docs.elementary-data.com/ elementary: +schema: 'elementary' @@ -28,7 +56,7 @@ models: And run ```dbt run --select elementary```. -Check out the [full documentation](https://docs.elementary-data.com/). +Check out the [full documentation](https://docs.elementary-data.com/) for generating the UI, alerts and adding anomaly detection tests. ## Run Results and dbt artifacts The package automatically uploads the dbt artifacts and run results to your tables in your data warehouse.