Add 'tmuxinator new --local' entry to README (#733)

* Add 'tmuxinator new --local' entry to README (#439) * Rework local project README entry * update CHANGELOG.md
tmuxinator · Dec 1, 2019 · 24d6910 · 24d6910
1 parent 24bb5d9
commit 24d6910
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 - correct edge tmux version detection (#728)
 
 ### Misc
+- document local project creation (#439)
 - add support for tmux 3.0 and 3.0a (#734)
 
 ## 1.1.2

diff --git a/README.md b/README.md
@@ -86,6 +86,14 @@ Create or edit your projects with:
 tmuxinator new [project]
 ```
 
+Create or edit a local project where the config file will be stored in the 
+current working directory (in `.tmuxinator.yml`) instead of the default 
+project configuration file location (e.g. `~/.config/tmuxinator`):
+
+```
+tmuxinator new --local [project]
+```
+
 For editing you can also use `tmuxinator open [project]`. `new` is aliased to
 `n`,`open` to `o`, and `edit` to `e`. Please note that dots can't be used in project
 names as tmux uses them internally to delimit between windows and panes.