diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2688b92 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,19 @@ +Changelog +========= + +[0.0.3](https://github.com/raphjaph/ordapi/releases/tag/0.0.3) - 2025-02-04 +--------------------------------------------------------------------------- + +### Added +- Add name to Docs workflow (#16) +- Add documentation (#14) +- Add License and badges (#13) +- Remove unnecessary awaits (#12) +- Adding remaining endpoints (#11) +- Publish 0.0.2 (#8) +- Add installation and usage instructions to README (#7) +- Add block-related endpoints (#5) +- Add CI (#6) +- Init TypeScript library (#2) +- Fix README (#1) +- Initial commit diff --git a/README.md b/README.md index 63ad8c1..bf2c4a8 100644 --- a/README.md +++ b/README.md @@ -95,3 +95,12 @@ function App() { ); } ``` + +### Publish release + +- update `package.json` version +- update version in `docs/generateHtml.ts` +- update all dependencies (`bun update`) +- prepare the CHANGELOG +- open release PR on github +- `bun publish` diff --git a/bun.lock b/bun.lock index 58ba2e2..cfd0127 100644 --- a/bun.lock +++ b/bun.lock @@ -4,11 +4,11 @@ "": { "name": "ordapi", "dependencies": { - "typescript-eslint": "^8.22.0", + "typescript-eslint": "^8.23.0", "zod": "^3.24.1", }, "devDependencies": { - "@types/bun": "^1.2.1", + "@types/bun": "^1.2.2", "@types/react": "^19.0.8", "@types/react-dom": "^19.0.3", "react": "^19.0.0", diff --git a/docs/generateHtml.ts b/docs/generateHtml.ts index 9c7acd5..d7d525f 100644 --- a/docs/generateHtml.ts +++ b/docs/generateHtml.ts @@ -120,7 +120,7 @@ function generateHtml() {
Simple TypeScript client for ord API.