Add use cases to readme (#6)

* Add use cases to readme

* Update create-table-of-contents.yml

* Don't run CI for markdown files

* Update README.md

* Auto update table of contents

* explain why we're ignoring main branch

Co-authored-by: joellabes <joellabes@users.noreply.github.com>

Author: joellabes

.github/workflows/ci.yml

@@ -2,9 +2,13 @@ name: Continuous Integration
 
 on:
   push:
+    paths-ignore:
+      - "**.md"
     branches:
       - "main"
   pull_request:
+    paths-ignore:
+      - "**.md"
 
 jobs:
   postgres:

.github/workflows/create-table-of-contents.yml

@@ -3,7 +3,7 @@ name: Update table of contents
 # Controls when the workflow will run
 on:
   push:
-    branches: '!main'
+    branches-ignore: 'main' #protected branch
     paths: ['README.md']
 
 jobs:

README.md

@@ -5,6 +5,8 @@
 * [About](#about)
    * [A note on refs](#warning-a-note-on-refs)
 * [Usage](#usage)
+   * [Inside of dbt Models](#inside-of-dbt-models)
+   * [Via the interactive dbt server (coming soon)](#via-the-interactive-dbt-server-coming-soon)
 * [Secondary calculations](#secondary-calculations)
    * [Period over Period (<a href="/macros/secondary_calculations/secondary_calculation_period_over_period.sql">source</a>)](#period-over-period-source)
    * [Period to Date (<a href="/macros/secondary_calculations/secondary_calculation_period_to_date.sql">source</a>)](#period-to-date-source)
@@ -17,7 +19,7 @@
 * [Experimental behaviour](#-experimental-behaviour)
    * [Dimensions on calendar tables](#dimensions-on-calendar-tables)
 
-<!-- Added by: runner, at: Thu Feb 10 01:29:12 UTC 2022 -->
+<!-- Added by: runner, at: Thu Feb 10 02:34:59 UTC 2022 -->
 
 <!--te-->
 
@@ -28,6 +30,8 @@ This dbt package generates queries based on [metrics](https://docs.getdbt.com/do
 To enable the dynamic referencing of models necessary for macro queries through the dbt Server, queries generated by this package do not participate in the DAG and `ref`'d nodes will not necessarily be built before they are accessed. Refer to the docs on [forcing dependencies](https://docs.getdbt.com/reference/dbt-jinja-functions/ref#forcing-dependencies) for more details.
 
 # Usage
+
+## Inside of dbt Models
 Access metrics [like any other macro](https://docs.getdbt.com/docs/building-a-dbt-project/jinja-macros#using-a-macro-from-a-package): 
 ```sql
 select * 
@@ -48,6 +52,11 @@ from {{ metrics.metric(
 ) }}
 ```
 
+You may want to materialize the results as a fixed table for querying.
+
+## Via the interactive dbt server (coming soon)
+When the [dbt server](https://blog.getdbt.com/licensing-dbt/) is released later in 2022, you will be able to access these macros interactively, without needing to build each variant as a single dbt model. For more information, check out the [keynote presentation from Coalesce 2021](https://www.getdbt.com/coalesce-2021/keynote-the-metrics-system/)
+
 # Secondary calculations
 Secondary calculations are window functions which act on the primary metric. You can use them to compare a metric's value to an earlier period and calculate year-to-date sums or rolling averages.
 
@@ -158,4 +167,4 @@ from {{ metrics.metric(
     dimensions=['plan', 'country', 'is_weekend'],
     secondary_calcs=[]
 ) }}
-```
+```