Skip to content

Commit 74c74ac

Browse files
committed
feat: Add GitHub release step to workflow and update installation instructions for pnpm
1 parent a40a659 commit 74c74ac

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

.github/workflows/release.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,9 @@ jobs:
4545
run: pnpm publish --access public
4646
env:
4747
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
48+
49+
- name: Create GitHub Release
50+
uses: softprops/action-gh-release@v2
51+
with:
52+
tag_name: ${{ github.ref_name }}
53+
generate_release_notes: true

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,19 @@ Current status: **Proof of Concept** stage. Core functionality is being validate
2525

2626
## Installation
2727

28+
1. Install the package:
2829
```bash
29-
npm install hono-routing-controllers
30+
pnpm install hono-routing-controllers
31+
```
32+
33+
1. Install required peer dependencies:
34+
```bash
35+
pnpm install hono reflect-metadata
36+
```
37+
38+
3. Add `reflect-metadata` import at the entry point of your application:
39+
```typescript
40+
import 'reflect-metadata';
3041
```
3142

3243
# 🚀 Quick Start
@@ -90,9 +101,9 @@ useRoutingController(
90101
### � Development
91102

92103
```bash
93-
npm run dev
94-
npm run build
95-
npm run test
104+
pnpm run dev
105+
pnpm run build
106+
pnpm run test
96107
```
97108

98109
## 🛑 Current Limitations

0 commit comments

Comments
 (0)