From 3e5c7a3c3bbce814aee6c28b3e54648affdbe01c Mon Sep 17 00:00:00 2001
From: Felipe Peter <felipe.peter@vorausrobotik.com>
Date: Thu, 14 Dec 2023 13:00:30 +0800
Subject: [PATCH] docs: Add basic instructions to README

---
 README.rst | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/README.rst b/README.rst
index 7dea8f8..79b6472 100644
--- a/README.rst
+++ b/README.rst
@@ -3,10 +3,19 @@ voraus Template Updater
 ===============================
 
 
-A CLI to keep cookiecutter-based projects up-to-date.
+A CLI to keep projects up-to-date that were bootstrapped with `cruft <https://cruft.github.io/cruft/>`_ + `cookiecutter <https://cookiecutter.readthedocs.io/en/stable/>`_.
 
+Install with::
 
+    pip install git@github.com:vorausrobotik/voraus-template-updater.git
 
-A longer description of your project goes here...
+Run with::
 
+    update-template <user or organization>
 
+A GitHub token will be retrieved from the ``GITHUB_TOKEN`` environment variable.
+It can also be passed via the ``--github-access-token`` option.
+
+Find out more by running::
+
+    update-template --help