template / commit
Readme updates.
README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 50959c4..544bbfa 100644 --- a/README.md +++ b/README.md @@ -128,6 +128,9 @@ I'm going to use this tool daily to figure out how it can be improved. While I am the only user, this app will stay at version `0.x.y`. At this point, breaking changes may happen. +I'll try to use feature branches, but main will sometimes be in a broken state. +Stable versions are tagged after I've had time to test it, so picking up those should be safe. + Once there are enough other users and enough new feature requirements are added, we'll transition to version `1.x.y`. ### Basic features @@ -145,19 +148,22 @@ Here are the basic features of the CLI that I want to keep: I want to keep this CLI simple. To that extent, I'm not interested in adding too many features. My main requirement right now is: `template blog topic` should do the same thing as `template --profile blog --name topic`. -The CLI should also not be too opinionated. Aside from `go`, there are no other requirements. Default profiles use need VSCode, but the user can always override that. - ### Future Features Here is the future feature list: -1. Publish Homebrew version of app -2. Publish Chocolatey version of app -3. Support for passing in a list of template values for custom values in the template. Use might look like this: `template work form123 --id=456 --corpOffice=SEA`. The passed-in extra values will be placed somewhere inside the template. Some value keys will not be allowed, like "time". +1. Create releases +2. Publish Homebrew version of app +3. Publish Chocolatey version of app +4. Support for passing in a list of template values for custom values in the template. Use might look like this: `template work form123 --id=456 --corpOffice=SEA`. The passed-in extra values will be placed somewhere inside the template. Some value keys will not be allowed, like "time". ## Contributing -Contributions are welcome, but unsolicited PRs are not. If you want to add a particular feature, open an issue first and suggest it. We'll discuss the feature and if I agree that it should be added, you can open a PR. I don't want to waste my time or your time. +Contributions are welcome, but unsolicited PRs are not. +If you want to add a particular feature, open an issue first and suggest it. +We'll discuss the feature and if I agree that it should be added, you can open a PR. + +I don't want to waste my time or your time. ## Authors and acknowledgment