Skip to content

Commit 869595d

Browse files
committed
Update docs
1 parent 69d7928 commit 869595d

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# TemplGen
44

5-
<img alt="TemplGen Logo" width="300px" height="300px" src="/media/logo.png">
5+
<img alt="TemplGen Logo" width="300px" height="300px" src="./media/logo.png">
66

77
Extensible template based file generator
88

@@ -16,9 +16,15 @@ Extensible template based file generator
1616

1717
<hr />
1818

19+
TemplGen is a small and extensible template based file generator module that
20+
provides a simple API for creating code scaffolding tools.
21+
22+
It borrows some ideas from [Nx](https://nx.dev/) but it is meant to be used as a
23+
building block for creating CLI tools rather than being a full fledged tool
24+
itself.
25+
1926
## Features
2027

21-
- Easy to use TypeScript API
2228
- ESM and CommonJS support
2329
- Support for copying binary files as well as rendering template files
2430
- Variable substitution in file names
@@ -61,7 +67,7 @@ await fileGenerator.generate(
6167
);
6268
```
6369

64-
See [example](https://github.com/fardjad/node-templgen/tree/main/example) for a working example.
70+
See [example](./example) for a working example.
6571

6672
### Advanced Usage
6773

package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
"generate",
88
"generator"
99
],
10-
"homepage": "https://github.com/fardjad/templgen",
10+
"homepage": "https://github.com/fardjad/node-templgen",
1111
"bugs": {
12-
"url": "https://github.com/fardjad/templgen/issues"
12+
"url": "https://github.com/fardjad/node-templgen/issues"
1313
},
1414
"repository": {
1515
"type": "git",
16-
"url": "git+ssh://[email protected]/fardjad/templgen.git"
16+
"url": "git+ssh://[email protected]/fardjad/node-templgen.git"
1717
},
1818
"license": "MIT",
1919
"author": "Fardjad Davari <[email protected]>",

0 commit comments

Comments
 (0)