Initial Commit
This commit is contained in:
37
.claude/templates/package-readme.template.md
Normal file
37
.claude/templates/package-readme.template.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# {packageName} - {shortDescription}
|
||||
|
||||
## Summary
|
||||
|
||||
{summary}
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
{installCommand}
|
||||
```
|
||||
|
||||
## Quick start
|
||||
|
||||
```ts
|
||||
{quickStartCode}
|
||||
```
|
||||
|
||||
{quickStartDescription}
|
||||
|
||||
{if:features}## What it does
|
||||
|
||||
{each:features:feature}- {feature}
|
||||
{/each}
|
||||
{/if}{if:modules}## Modules
|
||||
|
||||
{each:modules:mod}- [`{mod.name}`]({mod.path}) — {mod.description}
|
||||
{/each}
|
||||
{/if}{if:otelInstruments}## OpenTelemetry
|
||||
|
||||
{each:otelInstruments:inst}- {inst.type} `{inst.name}{if:inst.labels}{inst.labels}{/if}`
|
||||
{/each}
|
||||
{/if}{if:otelStatusValues}Status label values: {otelStatusValues}.
|
||||
{/if}
|
||||
## License
|
||||
|
||||
{license}
|
||||
Reference in New Issue
Block a user