You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-4Lines changed: 32 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,12 +12,21 @@ displaying guest-origin stats per property and searched cities. Moreover, it lis
12
12
unavailable due to scheduling conflicts, but would have been more ideal for you if your travel dates were more flexible.
13
13
14
14
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
16
16
hostel.
17
17
18
18
H.O.R was developed as a personal side project to simplify the process of selecting the "best" hostel from an extensive
19
19
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
+
[](https://chrome.google.com/webstore/detail/dfilmjjmeegkakfmnadkimgflocnnnbg)
26
+
[](https://chrome.google.com/webstore/detail/dfilmjjmeegkakfmnadkimgflocnnnbg)
27
+
[](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).
21
30
22
31
23
32
## Supported platforms
@@ -31,7 +40,7 @@ This section will be updated when additional browsers are supported.
31
40
## Development & Building
32
41
33
42
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).
35
44
36
45
The required versions of nodejs & yarn needed can be found at the [engines section](/package.json#L4-L6) of the
37
46
`package.json`.
@@ -50,8 +59,27 @@ Once build, head over to your Chrome browser and:
50
59
Congratulations, the extension should now be installed in your browser! Please note that in some cases, you may need to
51
60
`reload` the extension for the changes to take effect.
52
61
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
54
76
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.
0 commit comments