Skip to content

Commit b363495

Browse files
committed
Update README.
1 parent fc196ae commit b363495

1 file changed

Lines changed: 32 additions & 4 deletions

File tree

README.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,21 @@ displaying guest-origin stats per property and searched cities. Moreover, it lis
1212
unavailable due to scheduling conflicts, but would have been more ideal for you if your travel dates were more flexible.
1313

1414
In addition, the extension provides extra metrics by analyzing the availability and reviews per property, presenting
15-
this data directly on the property card. This might help facilitating your decision-making process when selecting a
15+
this data directly on the property card. This might help to facilitate your decision-making process when selecting a
1616
hostel.
1717

1818
H.O.R was developed as a personal side project to simplify the process of selecting the "best" hostel from an extensive
1919
range of good ones. It proved & continues to prove useful during my travels, assisting me in finding the most suitable
20-
place to stay depending on my mood, whether I was looking for some busy or more quiet place to stay at. :)
20+
place to stay depending on my mood, whether I was looking for some busy or quieter place to stay at. :)
21+
22+
23+
## Installation
24+
25+
[![Chrome Web Store Version](https://img.shields.io/chrome-web-store/v/dfilmjjmeegkakfmnadkimgflocnnnbg.svg?style=for-the-badge)](https://chrome.google.com/webstore/detail/dfilmjjmeegkakfmnadkimgflocnnnbg)
26+
[![Chrome Web Store Rating](https://img.shields.io/chrome-web-store/rating/dfilmjjmeegkakfmnadkimgflocnnnbg.svg?style=for-the-badge)](https://chrome.google.com/webstore/detail/dfilmjjmeegkakfmnadkimgflocnnnbg)
27+
[![Chrome Web Store Users](https://img.shields.io/chrome-web-store/users/dfilmjjmeegkakfmnadkimgflocnnnbg.svg?style=for-the-badge)](https://chrome.google.com/webstore/detail/dfilmjjmeegkakfmnadkimgflocnnnbg)
28+
29+
Install the extension directly from the [Chrome Web Store](https://chrome.google.com/webstore/detail/dfilmjjmeegkakfmnadkimgflocnnnbg).
2130

2231

2332
## Supported platforms
@@ -31,7 +40,7 @@ This section will be updated when additional browsers are supported.
3140
## Development & Building
3241

3342
Apart from the obvious [git](https://git-scm.com/) one :), you'll need [node.js](https://nodejs.org) and
34-
[yarn](https://yarnpkg.com/getting-started/install/) (utilize corepack magic, so you don't have to install that one)".
43+
[yarn](https://yarnpkg.com/getting-started/install/) (utilize corepack magic, so you don't have to install that one).
3544

3645
The required versions of nodejs & yarn needed can be found at the [engines section](/package.json#L4-L6) of the
3746
`package.json`.
@@ -50,8 +59,27 @@ Once build, head over to your Chrome browser and:
5059
Congratulations, the extension should now be installed in your browser! Please note that in some cases, you may need to
5160
`reload` the extension for the changes to take effect.
5261

53-
Additional `build` & `lint` commands can be found at the [scripts section](/package.json#L9-L16) of the `package.json`.
62+
Additional `build` & `lint` commands can be found at the [scripts section](/package.json#L9-L24) of the `package.json`.
63+
64+
65+
## Packaging & Deployment
66+
67+
### Environment Setup
68+
69+
**Note:** _This setup is optional and only required for extension packaging and shipping. It's unnecessary for local development._
70+
71+
For packaging and deployment functionality, you'll need to set up environment variables. Simply:
72+
* Copy `.env.example` to `.env` in the project root.
73+
* Fill in the actual values for your specific setup.
74+
75+
### Available Commands
5476

77+
Once environment is configured, you can use these packaging and deployment commands:
78+
* `yarn package:zip` - Creates a ZIP package for manual installation or Web Store upload.
79+
* `yarn package:crx` - Creates a signed CRX package for direct installation.
80+
* `yarn extension:upload` - Uploads the latest version to Chrome Web Store.
81+
* `yarn extension:publish` - Submits the current version for review and publication.
82+
* `yarn extension:deploy` - Uploads and publishes the latest version in one go.
5583

5684
## Contributing
5785

0 commit comments

Comments
 (0)