Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fardjad committed Aug 10, 2023
1 parent 69d7928 commit 869595d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# TemplGen

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

Extensible template based file generator

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

<hr />

TemplGen is a small and extensible template based file generator module that
provides a simple API for creating code scaffolding tools.

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

## Features

- Easy to use TypeScript API
- ESM and CommonJS support
- Support for copying binary files as well as rendering template files
- Variable substitution in file names
Expand Down Expand Up @@ -61,7 +67,7 @@ await fileGenerator.generate(
);
```

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

### Advanced Usage

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
"generate",
"generator"
],
"homepage": "https://github.com/fardjad/templgen",
"homepage": "https://github.com/fardjad/node-templgen",
"bugs": {
"url": "https://github.com/fardjad/templgen/issues"
"url": "https://github.com/fardjad/node-templgen/issues"
},
"repository": {
"type": "git",
"url": "git+ssh://[email protected]/fardjad/templgen.git"
"url": "git+ssh://[email protected]/fardjad/node-templgen.git"
},
"license": "MIT",
"author": "Fardjad Davari <[email protected]>",
Expand Down

0 comments on commit 869595d

Please sign in to comment.