-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add basic instructions to README
- Loading branch information
Showing
1 changed file
with
11 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 |