Skip to content

Commit

Permalink
update usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuadavidthomas committed Feb 16, 2024
1 parent 969cb9f commit ebd2355
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,14 @@ This template is built using [Copier](https://copier.readthedocs.io) and include
To use this template, you will need to install [Copier](https://copier.readthedocs.io) and then run the following command:

```bash
copier copy gh:westerveltco/django-twc-project <destination>
copier copy --trust gh:westerveltco/django-twc-project <destination>
```

> [!NOTE]
> The `--trust` flag is used to because this template uses `copier-template-extensions` to simplify some of the Jinja templating. You cannot use this template without trusting it. Please review the files within the [`extensions`](extensions) directory to see what is being done.
After running the above command, you will be prompted to fill in some information about your package. Once you have filled in the necessary information, Copier will generate the package for you.

## Examples

Examples are provided in the [`examples`](examples) directory.
Expand Down

0 comments on commit ebd2355

Please sign in to comment.