From d09ee6a5d654bb0c006e3bd766c482e64910c55d Mon Sep 17 00:00:00 2001
From: mariugul <marius.gulbrandsen@remarkable.no>
Date: Wed, 18 Sep 2024 11:04:50 +0200
Subject: [PATCH] docs: add a get started documentation

---
 docs/source/get_started.rst | 28 ++++++++++++++++++++++++++++
 docs/source/index.rst       |  5 ++---
 2 files changed, 30 insertions(+), 3 deletions(-)
 create mode 100644 docs/source/get_started.rst

diff --git a/docs/source/get_started.rst b/docs/source/get_started.rst
new file mode 100644
index 0000000..5e852c2
--- /dev/null
+++ b/docs/source/get_started.rst
@@ -0,0 +1,28 @@
+=========================
+Getting Started
+=========================
+
+Welcome to the **comeit** project! A linter for conventional commits. Follow the steps below to
+install and start using the package.
+
+1. **Install the package**:
+   
+   You can install **comeit** directly from PyPI using `pip`:
+
+   .. code-block:: bash
+
+      pip install comeit
+
+2. **Run the application**
+
+  **comeit** includes a CLI tool, you can run it like this:
+
+  .. code-block:: bash
+
+    comeit
+
+  By default, ``comeit`` uses ``git`` internally with ``gitpython`` to read all the commits on the
+  current branch. These are the commits that are parsed and reported if nothing else is specified.
+   
+
+You're ready to go! Explore the project documentation for further details.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index f4db72e..d5906ea 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -6,13 +6,12 @@
 comeit documentation
 ====================
 
-Add your content using ``reStructuredText`` syntax. See the
-`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
-documentation for details.
+Lint git commits in a Conventional Commits manner in pure Python.
 
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
+   get_started
    rules_config
\ No newline at end of file