Skip to content

Commit 798280a

Browse files
committed
Update docs
1 parent 3c60ca0 commit 798280a

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Extensible template based file generator
1919
TemplGen is a small and extensible template based file generator module that
2020
provides a simple API for creating code scaffolding tools.
2121

22-
It borrows some ideas from [Nx](https://nx.dev/) but it is meant to be used as a
22+
It borrows some ideas from [Nx][1] but it is meant to be used as a
2323
building block for creating CLI tools rather than being a full fledged tool
2424
itself.
2525

@@ -28,10 +28,10 @@ itself.
2828
- ESM and CommonJS support
2929
- Support for copying binary files as well as rendering template files
3030
- Variable substitution in file names
31-
- Use EJS (default) or any other template engine
32-
- Overridable file system methods. You can override the default functions used
31+
- Use EJS (by default) or [any other template engine][2]
32+
- Overridable file system methods. You can [override][3] the default functions used
3333
to create directories, read files, write files, and copy files. That is
34-
useful for testing, logging, implementing interactive prompts, etc.
34+
useful for [testing][4], logging, implementing interactive prompts, etc.
3535

3636
## Installation
3737

@@ -143,3 +143,8 @@ await fileGenerator.generate(
143143
variables,
144144
);
145145
```
146+
147+
[1]: https://nx.dev/core-features/plugin-features/use-code-generators
148+
[2]: #custom-template-engine
149+
[3]: #custom-file-system-functions
150+
[4]: ./src/index.test.ts

0 commit comments

Comments
 (0)