Skip to content

Latest commit

 

History

History
84 lines (52 loc) · 2.54 KB

README.md

File metadata and controls

84 lines (52 loc) · 2.54 KB

IGIHE-PLUS

1. Overview

IGIHE-PLUS is a browser extension for igihe.com with the following features:

  • Removing ads ✔
  • Changing Theme ✔
  • Bookmarking articles
  • Analytics Dashboard

Note 1: This project is under development so, the latest version has only checked features.

Note 2: By default all features are disabled, so user has to enable which feature they need to use.

2. How to test it locally

There are different ways to run a browser extension depending on which browser you are using.

Step 1: Clone repository

Open a terminal, command Prompt, PowerShell, or Git Bash. and navigate to the desired directory. Then run one of the following command:

  • Using https

    git clone 'https://github.com/obed71/igihe-plus.git'

  • Using ssh-key

    git clone '[email protected]:obed71/igihe-plus.git'

Note 3: If you don't have git in your computer, just download a zip file.

Step 2: Open a browser and run it

  • For Firefox users:

    • Navigate to about:debugging#/runtime/this-firefox
    • Click on Load temporary Add-on.
    • Open the extension's directory and select manifest.json file, or select the packaged extension (.zip file).

  • For Edge and Chrome users: read this post by Cassidy Williams.

3. Contributing

We welcome contributions to IGIHE-PLUS! If you have an idea for a new feature or have found a bug, please open an issue on our GitHub repository.

How to contribute

  1. Fork the repository: Click the "Fork" button at the top right corner of the repository page.
  2. Clone your fork: Clone your forked repository to your local machine.
git clone 'https://github.com/<your-username>/igihe-plus.git'
  1. Create a new branch: Create a new branch for your feature or bug fix.
git checkout -b my-feature-branch
  1. Make your changes: Implement your feature or bug fix.
  2. Commit your changes: Commit your changes with a descriptive commit message.
git commit -m "Add new feature: description"
  1. Push to your fork: Push your changes to your forked repository.
git push origin my-feature-branch
  1. Open a pull request: Go to the original repository and open a pull request with a description of your changes.

Note 4: Please ensure your code follows the project's coding standards and includes appropriate tests.

Thank you for contributing to IGIHE-PLUS!