Skip to content

Commit e605991

Browse files
committed
Update readme & add license in package.json
1 parent b280391 commit e605991

2 files changed

Lines changed: 15 additions & 7 deletions

File tree

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@ https://node.microformats.io
88

99
All commits to the `main` branch get auto-deployed to the live website [running on Heroku](https://node.microformats.io).
1010

11+
### Git workflow
12+
13+
The base branch is `next`. All PRs should target this branch.
14+
15+
To initiate a release:
16+
* Create a new branch, from `next` named `release/x.y.z`
17+
* Bump the version in `package.json` to `x.y.z`
18+
* Merge `release/x.y.z` to `main`. This will trigger the [deployment](#deployment).
19+
* Merge `main` into `next`
20+
1121
## Getting Started
1222

1323
This website is built using [Yarn](https://yarnpkg.com/).
@@ -23,15 +33,15 @@ Next, install the required dependencies and start the server:
2333

2434
```
2535
yarn install
26-
yarn run start
36+
yarn start
2737
# Or, if you'd like a different port:
28-
# PORT=5000 yarn run start
38+
# PORT=5000 yarn start
2939
```
3040

3141
You can view your running local application at this URL:
3242

3343
```
34-
http://localhost:9080
44+
http://localhost:9000
3545
```
3646

3747
## Requirements
@@ -55,7 +65,4 @@ If you find bugs, have feature requests or questions, please
5565

5666
Microformats Parser Website Node is dedicated to the public domain using Creative Commons -- CC0 1.0 Universal.
5767

58-
http://creativecommons.org/publicdomain/zero/1.0
59-
60-
## Contributors
61-
- [Jacky Alciné](https://github.com/jalcine) — https://jacky.wtf/about
68+
http://creativecommons.org/publicdomain/zero/1.0

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"name": "microformats-website-node",
33
"description": "A website written using Node to demonstrate Microformats2 usage",
44
"version": "1.1.0",
5+
"license": "CC0-1.0",
56
"engines": {
67
"node": "17.x",
78
"yarn": "1.x"

0 commit comments

Comments
 (0)