Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,16 @@ lefthook install

Replace or extend the template files to fit your project:

- **`src/cli.ts`** — Replace or remove the placeholder CLI. Remove this file, the `bin` entry in `package.json`, and the `yargs` and `@types/yargs` dependencies if your project doesn't need a CLI.
- **`src/cli.ts`** — Replace or remove the placeholder CLI.
- **`src/fibonacci.ts`** — Replace with your own library logic.
- **`src/index.ts`** — Update the public API exports to match your library.
- **`CLAUDE.md`** — Replace with guidance specific to your project.
- **`LICENSE`** — Replace with your preferred license, or keep the [Unlicense](https://unlicense.org/).
- **`package.json`** — Update the package name, description, version, author, and other metadata.
- **`README.md`** — Replace with a description of your project.

If your project doesn't need a CLI, remove `src/cli.ts`, the `bin` entry in `package.json`, and the `yargs` and `@types/yargs` dependencies.

## Development

Write code in `src/`. Test files live alongside source as `*.test.ts`. Run the test suite with:
Expand Down