Adding usage guide to README

README.md

@@ -9,6 +9,46 @@ Configure and enforce conventions for your dbt project.
   <img src="./images/logo.webp" alt="dbt-bouncer logo" width="500"/>
 </p>
 
+# How to use
+
+Generate a `manifest.json` by running `dbt parse`. Once completed, run `dbt-bouncer` to validate that your conventions are being maintained.
+
+## GitHub Actions
+
+```yaml
+steps:
+    ...
+
+    - uses: godatadriven/dbt-bouncer@v0
+      with:
+        dbt-artifacts-dir: ./<PATH_TO_DBT_PROJECT>/target
+
+    ...
+```
+
+## Docker
+
+Don't use GitHub Actions? You can still use dbt-bouncer via Docker:
+
+```bash
+docker pull ghcr.io/godatadriven/dbt-bouncer:v0
+
+docker run --rm \
+    --volume "$PWD/<PATH_TO_DBT_PROJECT>/target":/<PATH_TO_DBT_PROJECT>/target \
+    ghcr.io/godatadriven/dbt-bouncer:v0 \
+    /dbt-bouncer.pex --dbt-artifacts-dir <PATH_TO_DBT_PROJECT>/target
+```
+
+## Pex
+
+You can also run the `.pex` artifact directly once you have a python executable installed:
+
+```bash
+wget https://github.com/godatadriven/dbt-bouncer/blob/v0/dist/dbt-bouncer.pex -O dbt-bouncer.pex
+
+dbt-bouncer.pex --dbt-artifacts-dir <PATH_TO_DBT_PROJECT>/target
+```
+
 # Development
 
 To setup your development environment, fork this repository and run: