template / commit
Added examples to readme.
README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/README.md b/README.md index f5185ce..33a4331 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,50 @@ Post script had no output Note that user profiles are combined with the default ones. This is so you can run `template reset` to reset `~/.template.yaml`, but keep your local profiles/changes as-is. +## Examples + +### Use `daily` profile to create a new file + +```sh +template daily +``` + +### Use `daily` profile to create a new file with a project name + +```sh +template daily testing +``` + +### Use `daily` profile to create a new file with a project name that contains spaces + +```sh +template daily "this is a test" +``` + +### Use `daily` profile to create a new file with contents piped in from `ps` + +```sh +echo "$(ps)" | template daily +``` + +### Use `work` profile to create a folder with multiple files inside it + +```sh +template work +``` + +### Use `work` profile and project name to create a folder with multiple files inside it + +```sh +template work "fix-bug-123" +``` + +### Use `log` profile to create a `.log` from `stderr` and `stdout` from a `curl` command + +```sh +curl -X GET "https://httpbin.org/delay/3" -H "accept: application/json" 2>&1 | template log +``` + ## Requirements The application is a single executable, there are no special requirements.