Skip to content

Commit

Permalink
docs: Add basic instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Mr-Pepe committed Dec 14, 2023
1 parent d8928d4 commit 91b7d50
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,19 @@ voraus Template Updater
===============================


A CLI to keep cookiecutter-based projects up-to-date.
A CLI to keep `cruft <https://cruft.github.io/cruft/>`_/ `cookiecutter <https://cookiecutter.readthedocs.io/en/stable/>`_-based projects up-to-date.

Install with::

pip install [email protected]: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

0 comments on commit 91b7d50

Please sign in to comment.