Initial Commit
This commit is contained in:
34
docs/README-BASE-TEMPLATE.md
Normal file
34
docs/README-BASE-TEMPLATE.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# @suaveplan/{{package_name}} - {{title}}
|
||||
|
||||
{{summary}}
|
||||
|
||||
## Features
|
||||
|
||||
- {{features[0]}}
|
||||
- {{features[1]}}
|
||||
- {{features[2]}}
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
bun add @suaveplan/{{package_name}}
|
||||
```
|
||||
|
||||
## Quick start
|
||||
|
||||
```ts
|
||||
{{example}}
|
||||
```
|
||||
|
||||
## Full example
|
||||
|
||||
```ts
|
||||
{{full_example}}
|
||||
```
|
||||
|
||||
## Modules
|
||||
|
||||
- [`{{module[0].path}}`]({{module[0].full_path}}/README.md) — {{module[0].title}}
|
||||
- [`{{module[0].path}}`]({{module[1].full_path}}/README.md) — {{module[1].title}}
|
||||
- [`{{module[0].path}}`]({{module[2].full_path}}/README.md) — {{module[2].title}}
|
||||
- [`{{module[0].path}}`]({{module[3].full_path}}/README.md) — {{module[3].title}}
|
||||
Reference in New Issue
Block a user