Skip to content

Commit ab007cb

Browse files
docs: Updated Readme.md
1️⃣ Need to provide a clear and easy to follow, steps for installing and using the extension/add-on. ✔️ 2️⃣ Warn about the auto-update downside in manual install. ✔️ 3️⃣ Add relevant screenshots for ease of understanding. ✔️
1 parent 6543952 commit ab007cb

File tree

1 file changed

+91
-4
lines changed

1 file changed

+91
-4
lines changed

README.md

Lines changed: 91 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,96 @@ _Strip the CSS!_
88

99
<div align="center">
1010

11-
### OnlyHTML is an Open-Source Chrome extension to view, only the HTML of the webpage.
12-
13-
**_Note :_** This is not yet released on the **chrome web store.**
14-
11+
### OnlyHTML is an Open-Source browser extension to view, only the HTML of the webpage.
1512
</div>
1613

14+
## What it does?
15+
Most of the websites nowadays have a overwhelming amount of **CSS** in them, which makes them so pretty and user friendly. This motivated me to know, how would these websites look without **CSS**.
16+
17+
This gave birth to **OnlyHTML**, which removes all the CSS from the current viewing webpage.
18+
19+
## Usecases I think of
20+
There are two aspects, which I think one can gain/know using this add-on.
21+
1. **Importance of CSS**, and how it drastically improves the UI.
22+
2. **FUN!** seriously it is quite fun to see websites without CSS.
23+
24+
## Available for
25+
**OnlyHTML** browser extension is developed for both Chrome and Firefox, although Chrome version is not yet avaliable in the [chrome web store](https://chrome.google.com/webstore/category/extensions)
26+
27+
Firefox add-on is successfully verified and available on the official [Firefox add-on page](https://addons.mozilla.org/en-US/firefox/)
28+
29+
## Steps for using the extension
30+
**For Chrome:**
31+
32+
Not available as of now.
33+
34+
**For Firefox:**
35+
36+
There are two ways for you to use the Firefox add-on,
37+
1. Adding to your browser from [onlyhtml- Firefox add-on official site](https://addons.mozilla.org/en-US/firefox/addon/onlyhtml/).
38+
2. Manually installing using the **.xpi** file available in this repository.
39+
40+
### **Installing from the official Firefox add-on website**
41+
1. Head over [here](https://addons.mozilla.org/en-US/firefox/addon/onlyhtml/) using Firefox.
42+
2. Click on **Add to Firefox** Button.
43+
44+
![Step2](https://user-images.githubusercontent.com/64256342/147415243-cea9044d-a44c-4746-9a4c-a30fd16fe6c3.png)
45+
46+
3. Now the add-on is successfully added to your browser.
47+
48+
![step3](https://user-images.githubusercontent.com/64256342/147415298-5e57d1c8-4f2f-46cc-9ebb-f705771df4d0.png)
49+
50+
4. To use the add-on click on the icon shown in **step 3**, when viweing a webpage.
51+
5. **Voila! All CSS removed.**
52+
6. To have the CSS back, click on the same icon again.
53+
7. Alright have some **FUN!**
54+
55+
### **Installing using the .xpi file**
56+
To install the add-on using the .xpi file, follow the below steps.
57+
1. In this repository navigate to `Firfox/onlyhtml-1.0-fx.xpi` or [click here](https://github.com/code-reaper08/OnlyHTML/blob/main/Firefox/onlyhtml-1.0-fx.xpi).
58+
2. Click on the **Download** button.
59+
60+
![image](https://user-images.githubusercontent.com/64256342/147415422-884c22d1-f20c-41d2-8dc2-798070008768.png)
61+
62+
3. Open **Add-ons and Themes menu** or press `Ctrl+Shift+A`
63+
64+
![menu](https://user-images.githubusercontent.com/64256342/147415497-68a7d296-ea69-4421-a518-b5c1712137ec.png)
65+
66+
4. Click on gear icon and **Install Add-on from file...** option inside the menu.
67+
68+
![from file](https://user-images.githubusercontent.com/64256342/147415528-9bbe3bcb-a08f-41ee-b4aa-1578f93edd51.png)
69+
70+
5. Select the **.xpi** file, downloaded in **Step 2**
71+
6. Click on **Add** and **Okay** in the subsequent prompts.
72+
7. Now you can use the add-on normally.
73+
74+
_**Note:**_ The only downside for this approach is, the add-on is not auto-updatable.
75+
76+
## Found some bugs?
77+
File them in the [issues section](https://github.com/code-reaper08/OnlyHTML/issues). I'll fix them as soon as possible.
78+
Make sure to try it out, It may have some bugs, Hopefully I will be keeping an eye and continuously update it in the future.
79+
80+
## Licnese:
81+
```
82+
MIT License
83+
84+
Copyright (c) 2021 Vishwa.R
85+
86+
Permission is hereby granted, free of charge, to any person obtaining a copy
87+
of this software and associated documentation files (the "Software"), to deal
88+
in the Software without restriction, including without limitation the rights
89+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
90+
copies of the Software, and to permit persons to whom the Software is
91+
furnished to do so, subject to the following conditions:
92+
93+
The above copyright notice and this permission notice shall be included in all
94+
copies or substantial portions of the Software.
95+
96+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
97+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
98+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
99+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
100+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
101+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
102+
SOFTWARE.
103+
```

0 commit comments

Comments
 (0)