From 9e9b7d1b84b593f089572c9d9e8a073f881eb3d8 Mon Sep 17 00:00:00 2001
From: Drew Bednar <drew@androiddrew.com>
Date: Tue, 2 Jan 2024 19:52:22 -0500
Subject: [PATCH] Add usage instructions

---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index dc3106f..e57a3b4 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,23 @@
 
 A basic cookiecutter template for most Androiddrew style repos.
 
+## Usage
+
+With [Cookiecutter installed](https://cookiecutter.readthedocs.io/en/stable/), execute the following command and provide your template parameters. 
+
+```
+cookiecutter https://git.runcible.io/androiddrew/cookiecutter-basic
+```
+
+Once templated, you can change into the new project directory and execute the `scripts/bootstrap.sh` script. 
+
+```
+cd <cookiecutter.project_slug>
+./scripts/bootstrap.sh
+```
+
+This will create a Python virtual environment if one is not already enabled, install [pip-tools](https://github.com/jazzband/pip-tools/), compile the requirements.in and dev-requirements.in files, install the initial dependencies, initialize the project as a git repository, and install the [pre-commit hooks](https://pre-commit.com/). 
+
 ## Licenses
 
 Within a `pyproject.toml` file the license section expects the string identifier as determined by https://spdx.org/licenses/. This project supports a small subset of these licenses. 
@@ -10,4 +27,4 @@ Example:
 ```
 [project]
 license = {text = "MIT"}
-```
\ No newline at end of file
+```