Documentation updates

jeremiahhansen · Feb 19, 2020 · d10dd4d · d10dd4d
1 parent dc349c8
commit d10dd4d
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,12 @@
 # snowflake-helper-dbt
 A re-usable Snowflake helper package for dbt
+
+## Macros
+### Materializations
+Custom materializations which leverage native Snowflake capabilities
+
+#### sfc_incremental
+An incremental materialization pattern leveraging Snowflake streams
+
+#### sfc_task
+An experimental materialization to manage Snowflake tasks. Not sure if this fits the dbt paradigm correctly.
diff --git a/docs/project_overview.md b/docs/project_overview.md
@@ -0,0 +1,16 @@
+{% docs __overview__ %}
+
+# snowflake-helper-dbt
+A re-usable Snowflake helper package for dbt
+
+## Macros
+### Materializations
+Custom materializations which leverage native Snowflake capabilities
+
+#### sfc_incremental
+An incremental materialization pattern leveraging Snowflake streams
+
+#### sfc_task
+An experimental materialization to manage Snowflake tasks. Not sure if this fits the dbt paradigm correctly.
+
+{% enddocs %}