Skip to content

Commit

Permalink
Merge pull request #93 from elementary-data/update_docs_0-9
Browse files Browse the repository at this point in the history
docs fix for utils 0.9
  • Loading branch information
IDoneShaveIt authored Aug 30, 2022
2 parents 77f2773 + eb203d2 commit 3e77209
Showing 1 changed file with 31 additions and 3 deletions.
34 changes: 31 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,48 @@ 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 '<your_schema>_elementary'
## see docs: https://docs.elementary-data.com/
## for details, see docs: https://docs.elementary-data.com/
elementary:
+schema: 'elementary'
```

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.
Expand Down

0 comments on commit 3e77209

Please sign in to comment.