Release 0.0.3 (#17)

Author: raphjaph

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

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`

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",

docs/generateHtml.ts

@@ -120,7 +120,7 @@ function generateHtml() {
             <div class="flex flex-col gap-2">
                 <div class="flex justify-between items-center">
                     <div>
-                        <h1 class="text-2xl font-bold">OrdAPI v0.0.2</h1>
+                        <h1 class="text-2xl font-bold">OrdAPI v0.0.3</h1>
                         <p class="text-green-400 mt-1">Simple TypeScript client for ord API.</p>
                     </div>
                     <div class="flex gap-4">
@@ -210,4 +210,4 @@ function generateHtml() {
   console.log('Documentation HTML generated successfully!');
 }
 
-generateHtml();
+generateHtml();

justfile

@@ -18,5 +18,14 @@ docs:
 
 ci: install lint test
 
+prepare-changelog revision='master':
+  #!/usr/bin/env bash
+  set -euxo pipefail
+  git checkout {{ revision }}
+  git pull origin {{ revision }}
+  echo >> CHANGELOG.md
+  git log --pretty='format:- %s' >> CHANGELOG.md
+  $EDITOR CHANGELOG.md
+
 publish:
   bun publish

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ordapi",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "license": "CC0-1.0",
   "keywords": [
     "ordinals",
@@ -30,11 +30,11 @@
     }
   },
   "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",