Skip to content

Commit

Permalink
Merge pull request #2 from BunnyWay/misc-fix-readme
Browse files Browse the repository at this point in the history
Update README Description
  • Loading branch information
antho-bunny authored Sep 9, 2024
2 parents c167df8 + 1a138b1 commit d3a98f0
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 8 deletions.
30 changes: 23 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This templates demonstrates a basic Pet Store API for Bunny using a local `Deno`
> fledged example with `node` instead!
This templated script is currently deployed
[here](https://es-hono-pet-store-9ww3g.b-cdn.net/).
[here](https://es-hono-pet-store-9ww3g.b-cdn.net/swagger).

## Setup

Expand All @@ -28,10 +28,26 @@ We also use `pnpm` to use `changeset`.

## Changeset

In this template, we handle versionning with [changeset](https://github.com/changesets/changesets),
each time you do a change, you'll need to indicate the kind of changes you are
doing so we can have the auto-release process ongoing by doing:
This template uses [changeset](https://github.com/changesets/changesets) for
version management. Changeset helps track and document changes in your project,
making it easier to manage releases and generate changelogs.

```
pnpm changeset
```
When you make changes to the project, you should create a changeset to describe
those changes:

1. Run the following command:
```
pnpm changeset
```
2. Follow the prompts to select the type of change (major, minor, or patch) and provide a brief description.
3. Commit the generated changeset file along with your code changes.

This process ensures that all modifications are properly documented and
versioned, facilitating smoother releases and better communication about
project updates.

When you merge a pull request that includes a changeset, it will automatically
create an associated pull request to release your changes.

This new pull request will trigger the release process of the script to your
PullZone in Bunny.
2 changes: 1 addition & 1 deletion src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ init({ store: petStore })(app);
const listener = BunnySDK.net.tcp.unstable_new();
console.log("Listening on: ", BunnySDK.net.tcp.toString(listener));
BunnySDK.net.http.serve(
(req) => {
(req: Request): Response | Promise<Response> => {
console.log(`[INFO]: ${req.method} - ${req.url}`);
return app.fetch(req);
},
Expand Down

0 comments on commit d3a98f0

Please sign in to comment.