Skip to content

Commit 1bbeba5

Browse files
committed
readme tweaks
1 parent 3c598c1 commit 1bbeba5

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ A React component and Web Component for integrating the ACCESS Q&A Bot into your
44

55
## Installation
66

7-
*npm package may not be available yet*
8-
97
```bash
108
npm install @snf/access-qa-bot
119
```
@@ -151,7 +149,7 @@ The **index.html** file is focused on the React component usage, while **demo.ht
151149
## Development and Testing
152150

153151
### Development Server
154-
When running the default development script (`npm start` or `yarn start`), the application serves the content from the `public` directory using React's development server. This shows the default React implementation with hot reloading enabled.
152+
When running the default development script (`npm start` or `yarn start`), the application serves the content from the `public` directory using React's development server. This shows the default React implementation with hot reloading enabled. Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
155153

156154
```bash
157155
# Start the development server (React implementation)

publishing.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,19 @@ Create a PR. Once approved, merge your feature branch to main, including the ver
7171

7272
### 3. Create Tag
7373

74-
After merging to main, create a tag matching your version:
74+
After merging to main, create a tag matching your version and a make a GitHub release:
7575

7676
```bash
7777
git checkout main
7878
git pull
7979
git tag -a v0.2.0 -m "Release version 0.2.0" # Match your actual version
8080
git push origin v0.2.0
8181
```
82+
- Click on the "Releases" tab in the GitHub repository
83+
- Click "Draft a new release"
84+
- Select the tag you just created
85+
- Add a title and description
86+
- Click "Publish release"
8287

8388
This tag will be used by the jsdelivr CDN.
8489

0 commit comments

Comments
 (0)