Skip to content

Commit

Permalink
docs: Add note about template hook dependencies (#3)
Browse files Browse the repository at this point in the history
Adds a note that any hook dependencies must be installed before running
the updater.
  • Loading branch information
Mr-Pepe authored Jan 31, 2024
1 parent f6471d3 commit 8261e31
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ Run with::
A GitHub token will be retrieved from the ``GITHUB_TOKEN`` environment variable.
It can also be passed via the ``--github-access-token`` option.

Any dependencies required by a template's pre/post-generate hooks must be installed into the same environment
as the template updater.

Find out more by running::

update-template --help

0 comments on commit 8261e31

Please sign in to comment.