From 226cc0a734425c9085d84a7c7db969fe287d66b3 Mon Sep 17 00:00:00 2001
From: Jochem van Dooren <jochemmathijs.vandooren@teampicnic.com>
Date: Mon, 27 May 2024 11:42:44 +0200
Subject: [PATCH] Add documentation to get started (#25)

---
 docs/get_started.md | 51 +++++++++++++++++++++++++++++++++++++++++++++
 mkdocs.yml          |  1 +
 2 files changed, 52 insertions(+)
 create mode 100644 docs/get_started.md

diff --git a/docs/get_started.md b/docs/get_started.md
new file mode 100644
index 0000000..f57a9da
--- /dev/null
+++ b/docs/get_started.md
@@ -0,0 +1,51 @@
+# Get started
+
+`dbt-score` is a Python library that is easy to install and use. The minimum
+required version of Python is `3.11`.
+
+## Installation
+
+Installation of `dbt-score` is simple:
+
+```shell
+pip install dbt-score
+```
+
+If a virtual environment is used to run dbt, make sure to install `dbt-score` in
+the same environment.
+
+## Usage
+
+`dbt-score` uses the output of `dbt parse` (`manifest.json`) as input.
+Therefore, it is recommended to run `dbt-score` from the root of your dbt
+project. By default, it will look for `manifest.json` in dbt's `target`
+directory.
+
+`dbt-score` can be executed from the command line:
+
+```shell
+dbt-score lint
+```
+
+To use a different manifest file, use the `--manifest` option:
+
+```shell
+dbt-score lint --manifest path/to/manifest.json
+```
+
+It's also possible to automatically run `dbt parse`, to generate the
+`manifest.json` file:
+
+```shell
+dbt-score lint --run-dbt-parse
+```
+
+To get more information on how to run `dbt-score`, `--help` can be used:
+
+```shell
+dbt-score --help
+```
+
+```shell
+dbt-score lint --help
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index 273f3c4..09a6afb 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -17,6 +17,7 @@ markdown_extensions:
   - pymdownx.superfences
 nav:
   - Home: index.md
+  - Get started: get_started.md
   - Rules:
       - rules/generic.md
   - Reference: