Skip to content

Improve README.md for newcomers #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 11, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
This [dbt](https://github.com/fishtown-analytics/dbt) package contains macros that can be (re)used across dbt projects.

## Getting started

To use dbt-utils:

1. Reference the package in your dbt project by creating a `packages.yml` file, which should look something like:

```
packages:
- git: "https://github.com/fishtown-analytics/dbt-utils.git"
revision: 0.1.22
```
The revision key pins the dependency on a specific release of dbt-utils. Consult the [releases](https://github.com/fishtown-analytics/dbt-utils/releases) for information about the latest release.

2. Install the package by executing `dbt deps`

Detailed information on packages can be found in dbt's documentation in the [Package Management](https://docs.getdbt.com/docs/package-management) section.

----

## Macros
### Cross-database
#### current_timestamp ([source](macros/cross_db_utils/current_timestamp.sql))
Expand Down Expand Up @@ -132,7 +151,7 @@ version: 2

models:
- name: model_name
tests:
tests:
- dbt_utils.recency:
datepart: day
field: created_at
Expand All @@ -152,7 +171,7 @@ models:
- name: col_name
tests:
- dbt_utils.at_least_one


```

Expand Down