Adds NOTE regarding cookiecutter invocation with -f

TjWallas · Jun 26, 2017 · 5f68440 · 5f68440
1 parent 5f524d9
commit 5f68440
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,4 @@
 # bash-cookiecutter
 A cookiecutter template for writing safe bash scripts
+
+*NOTE*: This template creates a script file in the current directory `.`. Cookiecutter fails to create a directory if it already exists on the filesystem by default. As `.` is used as the cookiecutter directory name, cookiecutter needs to be invoked with the `-f` option to force-overwrite files in an existing directory `.`.