Skip to content

Commit a7a8877

Browse files
committed
docs: README
1 parent a758bd9 commit a7a8877

File tree

3 files changed

+33
-3
lines changed

3 files changed

+33
-3
lines changed

β€ŽCHANGELOG.mdβ€Ž

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,35 @@ Releases are generated automatically by [semantic-release](https://github.com/se
99

1010
---
1111

12-
## [2.0.0] - 2024
12+
## [2.1.0] - 2026-03-30
13+
14+
### Added
15+
16+
- **Interactive setup wizard** (`npm run setup`) β€” walks through package name, description, GitHub username/repo, author, license, and keywords one by one with live validation, shows a full preview before writing, then updates `package.json`, `README.md`, `AGENTS.md`, and `CONTRIBUTING.md` in one go
17+
- `prompts` added to `devDependencies` to power the wizard
18+
19+
### Fixed
20+
21+
- **Husky v9 migration** β€” removed deprecated `#!/usr/bin/env sh` + `. "$(dirname -- "$0")/_/husky.sh"` lines from both `.husky/pre-commit` and `.husky/commit-msg` (they will hard-fail in v10)
22+
- `pre-commit` hook now correctly delegates to `npx lint-staged` instead of running lint/prettier directly
23+
- `commit-msg` hook now passes `$1` to `commitlint --edit` as required
24+
- `prepare` script updated from `husky install` β†’ `husky` (the v9 API)
25+
- `husky:setup` simplified β€” `husky add` was removed in v9; hooks are plain files
26+
27+
---
28+
29+
## [2.0.0] - 2026-03-30
1330

1431
### Changed (Breaking)
32+
1533
- Migrated build system to `react-native-builder-bob` (dual CJS/ESM output)
1634
- Renamed source directory from `lib/` to `src/`
1735
- `main` now points to `lib/commonjs/index.js` (was `build/dist/index.js`)
1836
- Added `module` and `types` fields to `package.json`
1937
- Added `exports` map for proper ESM/CJS resolution
2038

2139
### Added
40+
2241
- Complete TypeScript strict-mode example component (`MyComponent`)
2342
- Complete typed custom hook example (`useMyHook`) with bounded counter logic
2443
- Full test suite with `@testing-library/react-native`
@@ -35,6 +54,7 @@ Releases are generated automatically by [semantic-release](https://github.com/se
3554
- `CONTRIBUTING.md`
3655

3756
### Fixed
57+
3858
- GitHub Actions updated from v2 to v4
3959
- `lint-staged` now correctly configured (was installed but unused)
4060
- `cpx` dependency removed (bob handles asset copying)

β€ŽREADME.mdβ€Ž

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,26 @@ A modern, production-ready starter for building React Native TypeScript librarie
1111

1212
---
1313

14+
## What's new in 2.1.0
15+
16+
- **Interactive setup wizard** β€” run `npm run setup` after cloning to configure your library name, author, repo URLs, license, and keywords step by step. Validates every field, shows a preview, and writes all files in one go.
17+
- **Husky v9** β€” hooks migrated to the v9 format. Git hooks now install automatically on `npm install` with no extra step.
18+
19+
See the full [CHANGELOG](CHANGELOG.md) for all changes including the 2.0.0 redesign.
20+
21+
---
22+
1423
## Features
1524

1625
- **react-native-builder-bob** β€” dual CJS + ESM + TypeScript declarations
1726
- **Strict TypeScript** β€” `noImplicitAny`, `strictNullChecks`, `noUnusedLocals`
1827
- **Jest + @testing-library/react-native** β€” full test suite with coverage thresholds
1928
- **ESLint + Prettier** β€” consistent code style, enforced on commit via `lint-staged`
20-
- **Husky + commitlint** β€” conventional commit enforcement
29+
- **Husky v9 + commitlint** β€” conventional commit enforcement, hooks install on `npm install`
2130
- **semantic-release** β€” automated versioning, changelog, and npm publish
2231
- **GitHub Actions** β€” CI pipeline (typecheck + lint + test + build) and release pipeline
2332
- **AI-Ready** β€” `AGENTS.md`, Cursor rules, and full TSDoc on every export
33+
- **Interactive setup wizard** β€” `npm run setup` to configure your library in 60 seconds
2434
- **Example component and hook** β€” reference implementations to clone from
2535

2636
---

β€Žpackage.jsonβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-native-typescript-library-starter",
3-
"version": "2.0.0",
3+
"version": "2.1.0",
44
"description": "A modern, AI-ready React Native TypeScript library starter with dual CJS/ESM output, full test setup, and developer-first tooling.",
55
"main": "lib/commonjs/index.js",
66
"module": "lib/module/index.js",

0 commit comments

Comments
Β (0)