Skip to content

Commit c9c4936

Browse files
committed
update README.md
1 parent ec2811d commit c9c4936

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

README.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,32 @@
11
# Hashnode browser extension for Firefox and Google Chrome 🕸
22

3-
Google chrome and Mozilla firefox browser extension with hot & trending posts on tap. Built with Node.js `v8.9` using React, Parcel, and Sass.
4-
5-
## Setup
3+
Google chrome and Mozilla firefox browser extension with hot & trending posts on tap.
4+
Built with Node.js `v8.9` using React, Parcel, and Sass.
5+
Follows Standard JS
66

7+
## Yarn setup
78
```
89
git clone https://github.com/Hashnode/hashnode-chrome-extension
9-
yarn
10-
yarn start
10+
yarn install --ignore-engines
11+
yarn start // starts the web app
12+
```
13+
##### Google Chrome extension
14+
15+
```
16+
yarn start-chrome // same as web app but is served from ./dist/dist-chrome
17+
yarn build-chrome // builds for chrome and will be available in ./builds/chrome
1118
```
19+
##### Mozilla Firefox extension
1220

13-
In order to live test the extension copy the `manifest.json` file manually to `./dist` folder. Keep making changes and the parcel takes care of the rest.
21+
```
22+
yarn start-firefox // same as web app but is served from ./dist/dist-firefox
23+
yarn build-firefox // builds for firefox and will be available in ./builds/firefox
24+
```
1425

15-
**🔴 Changes to the manifest.json must be made to the one in root folder and dist folder should be untouched.**
26+
`manifest.json` files are maintained sperately for firefox and chrome in their respective folders.
27+
In order to live test the extension copy the `manifest.json` file manually to respective `./dist/{dist-chrome|dist-firefox}` folder. Keep making changes and the parcel takes care of the rest.
28+
29+
**🔴 Changes to the manifest.json must be made to the respective folder and dist folder should be untouched. Instead manually copy if you are testing it locally**
1630

1731
----
1832

@@ -21,8 +35,11 @@ Run `yarn build`. This time no need to copy manifest file manually. Everything i
2135

2236
---
2337

24-
### Procedure to load extension
25-
Visit `chrome://extension`, click on `load unpacked` and select dist folder with `manifest.json` file in it and you are good to go.
38+
### Procedure to load extension for chrome
39+
Visit `chrome://extension` in Google Chrome, click on `Load unpacked` and select build/dist folder with `manifest.json` file in it and you are good to go.
40+
41+
### Procedure to load extension for firefox
42+
Visit `about:debugging#addons` in Mozilla Firefox, click on `Load Temporary Add-on` and select the firefox build/dist folder with `manifest.json` in it and you are good to go.
2643

2744
- You can test live as you develop by keeping the parcel server running.
2845
- If you want to inpect things, you can right click like a normal webpage on the dropdown.

0 commit comments

Comments
 (0)