Skip to content

Latest commit

 

History

History
88 lines (64 loc) · 3.9 KB

README.md

File metadata and controls

88 lines (64 loc) · 3.9 KB

Sardiya

About

Welcome to the official repository of Sardiya! This open-source project is designed to enhance your browsing experience by displaying the original native names of occupied and colonialised territories around the world. Our goal is to reclaim our native narrative through the digital space.

DEMO

How to Use

  1. Install the Extension:

    • Clone this repository and load the extension manually: 
      git clone https://github.com/alsha3b/sardiyeh.git
      • Open Chrome and navigate to chrome://extensions/.
      • Enable "Developer mode" at the top right.
      • Click "Load unpacked" and select the cloned directory.

  2. Using the Extension:

    • Click on the extension icon in the Chrome toolbar.
    • Turn on the extension through the popup and see a table of the original names.
    • Browse the web and see the native names of places.

How to Contribute

We welcome contributions from the community! Here's how you can help:

  1. Fork the repository:

    • Click the "Fork" button at the top right of this page to create a copy of this repository in your GitHub account.

  2. Clone your fork:

    git clone https://github.com/alsha3b/sardiyeh.git

  3. Create a branch:

    git checkout -b feature/your-feature-name

  4. Make your changes:

    • Add your code and make sure it follows the extension's goal.

  5. Commit and push:

    git add .
git commit -m "Add your feature description"
git push origin feature/your-feature-name

  6. Create a pull request:

    • Go to your forked repository on GitHub.
    • Click the “New pull request” button.
    • Provide a detailed description of your changes and submit the pull request.

Feature list

Here are a couple of ideas for new features for the extension, feel free to think of new ones:

  • Reverts: Revert to the original text in DOM elements when switching the extension off.
  • Underline Replaced Words: Visually indicate replaced words in the browser by underlining them.
  • Word Selection Tooltip: [x] Show a tooltip with replacement text-input when a word is selected in the browser. KUDOS TO SammyAbukmeil
  • Submit Information: Show a dialog to allow the user to choose a word from the list and submit contextual information about the place.
  • Google Maps Canvas Support: Enable the extension to work on Google Maps canvas elements.
  • Performance Optimizations: Improve overall performance through code optimizations.
  • UI Improvements: Implement the latest design, font and colors from the Figma design file.

Ports to Safari and Firefox

We would love to expand the reach of Sardiya by porting it to Safari and Firefox. If you have experience with developing extensions for these browsers and would like to contribute, we welcome your help!

How You Can Help

  1. Safari:

    • Familiarize yourself with the Safari Extensions Development Guide.
    • Port the extension code to be compatible with Safari.
    • Test the extension thoroughly to ensure all features work as expected.
    • Submit your changes via a pull request.

  2. Firefox:

    • Familiarize yourself with the Firefox Extension Development Guide.
    • Port the extension code to be compatible with Firefox.
    • Test the extension thoroughly to ensure all features work as expected.
    • Submit your changes via a pull request.

We appreciate your contributions and look forward to collaborating with you to make Sardiya available on more platforms!