Skip to content

Commit 3301561

Browse files
committed
Update README
1 parent 086a0f6 commit 3301561

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,9 @@ Run `kickstart --help` for a full listing of the available commands and their fl
3131
- It has conditional cleanup to not let irrelevant files in the output directory after generation
3232
- Templates can be made for any kind of projects/languages
3333
- Case conversion filters, e.g. `camelCase` to `CamelCase`
34+
- Pre-gen and post-gen hooks that can execute templated scripts
3435

35-
The main drawback compared to cookiecutter is the lack of hook scripts support, which can be mitigated a bit by the conditional cleanup.
36-
37-
Lastly, since Windows does not allow `|` in file paths, you may use a [tera built-in filter][builtin]
36+
Since Windows does not allow `|` in file paths, you may use a [tera built-in filter][builtin]
3837
by using the `$$` separator instead.
3938

4039
Note that, in file templates, you should keep using `|` for filtering, as the `$$` syntax is only for files and directories.
@@ -75,6 +74,9 @@ authors = [
7574

7675
]
7776

77+
# Whether to follow the symlinks when going through the files in the template
78+
follow_symlinks = false
79+
7880
# Optional, a list of keywords for this template
7981
keywords = [
8082

@@ -228,14 +230,15 @@ You can use these like any other filter, e.g. `{{variable_name | camel_case}}`.
228230

229231
## Changelog
230232

231-
### 0.5.0 (unreleased)
233+
### 0.5.0 (2024-12-13)
232234

233235
- The `sub-dir` parameter has been renamed to `directory` in the CLI
234236
- Templates with a `directory` field will now no longer include that directory name in the output
235237
- `copy_without_render` elements are now templated and refer to the template relative path if specified
236238
- Avoid path traversals in cleanup
237239
- Add pre-gen and post-gen hooks
238240
- Force `output-dir` to be selected in the CLI to avoid surprises
241+
- Add support for following symlinks
239242

240243
### 0.4.0 (2023-08-02)
241244

0 commit comments

Comments
 (0)