template / commit
minor doc update
README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index eff1fd8..dfddda0 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,23 @@ template template is a command-line interface (CLI) tool that automates the creation of files and folders with pre-defined names and contents, so you can focus on your work and not on repetitive setup tasks. +## Example + +For this example, pretend that today is April 14, 2025. + +```sh +$ template daily "Cool Project" +Profile: daily +Project name: Cool Project +Loaded config from /Users/pavel/.template.yaml +Loaded user config from /Users/pavel/.template.user.yaml, combining with global config +Creating file: /Users/pavel/DailyNotes/2025-04-04-Cool Project.md +Executing post script: sh -c code . "/Users/pavel/DailyNotes/2025-04-04-Cool Project.md" +Post script had no output +``` + +## Motivation + As developers and content creators, we often need to create files and folders with specific naming conventions, such as time-stamped file names, project-specific prefixes, and consistent suffixes. We also frequently need to populate these files with pre-defined contents, such as boilerplate code or templates for documentation. These tasks can be tedious and error-prone when done manually, especially when working on multiple projects or collaborating with others. template simplifies these tasks by providing a flexible and customizable way to create files and folders with consistent naming and content. With template, you can define your own naming patterns, file templates, and directory structures, or use pre-configured profiles that come with the tool. You can also pass in parameters at runtime to customize the output further, such as including a project name or arbitrary template data. @@ -243,6 +260,11 @@ Clone the repo and run these commands from the repo directory: ```sh make install +``` + +If this is your first installation or you want to reset your config to the default, run: + +```sh template reset ```