Skip to content

Commit

Permalink
docs: Updated Readme.md
Browse files Browse the repository at this point in the history
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. ✔️
  • Loading branch information
code-reaper08 authored Dec 26, 2021
1 parent 6543952 commit ab007cb
Showing 1 changed file with 91 additions and 4 deletions.
95 changes: 91 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,96 @@ _Strip the CSS!_

<div align="center">

### OnlyHTML is an Open-Source Chrome extension to view, only the HTML of the webpage.

**_Note :_** This is not yet released on the **chrome web store.**

### OnlyHTML is an Open-Source browser extension to view, only the HTML of the webpage.
</div>

## What it does?
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**.

This gave birth to **OnlyHTML**, which removes all the CSS from the current viewing webpage.

## Usecases I think of
There are two aspects, which I think one can gain/know using this add-on.
1. **Importance of CSS**, and how it drastically improves the UI.
2. **FUN!** seriously it is quite fun to see websites without CSS.

## Available for
**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)

Firefox add-on is successfully verified and available on the official [Firefox add-on page](https://addons.mozilla.org/en-US/firefox/)

## Steps for using the extension
**For Chrome:**

Not available as of now.

**For Firefox:**

There are two ways for you to use the Firefox add-on,
1. Adding to your browser from [onlyhtml- Firefox add-on official site](https://addons.mozilla.org/en-US/firefox/addon/onlyhtml/).
2. Manually installing using the **.xpi** file available in this repository.

### **Installing from the official Firefox add-on website**
1. Head over [here](https://addons.mozilla.org/en-US/firefox/addon/onlyhtml/) using Firefox.
2. Click on **Add to Firefox** Button.

![Step2](https://user-images.githubusercontent.com/64256342/147415243-cea9044d-a44c-4746-9a4c-a30fd16fe6c3.png)

3. Now the add-on is successfully added to your browser.

![step3](https://user-images.githubusercontent.com/64256342/147415298-5e57d1c8-4f2f-46cc-9ebb-f705771df4d0.png)

4. To use the add-on click on the icon shown in **step 3**, when viweing a webpage.
5. **Voila! All CSS removed.**
6. To have the CSS back, click on the same icon again.
7. Alright have some **FUN!**

### **Installing using the .xpi file**
To install the add-on using the .xpi file, follow the below steps.
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).
2. Click on the **Download** button.

![image](https://user-images.githubusercontent.com/64256342/147415422-884c22d1-f20c-41d2-8dc2-798070008768.png)

3. Open **Add-ons and Themes menu** or press `Ctrl+Shift+A`

![menu](https://user-images.githubusercontent.com/64256342/147415497-68a7d296-ea69-4421-a518-b5c1712137ec.png)

4. Click on gear icon and **Install Add-on from file...** option inside the menu.

![from file](https://user-images.githubusercontent.com/64256342/147415528-9bbe3bcb-a08f-41ee-b4aa-1578f93edd51.png)

5. Select the **.xpi** file, downloaded in **Step 2**
6. Click on **Add** and **Okay** in the subsequent prompts.
7. Now you can use the add-on normally.

_**Note:**_ The only downside for this approach is, the add-on is not auto-updatable.

## Found some bugs?
File them in the [issues section](https://github.com/code-reaper08/OnlyHTML/issues). I'll fix them as soon as possible.
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.

## Licnese:
```
MIT License
Copyright (c) 2021 Vishwa.R
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

0 comments on commit ab007cb

Please sign in to comment.