Create README.md

README.md

@@ -0,0 +1,46 @@
+
+#  Mandaic to Hebrew
+
+Mandaic to Hebrew is a Chrome extension that allows you to effortlessly transliterate Mandaic characters to their corresponding Hebrew equivalents. With Mandaic to Hebrew, you can easily read and understand Mandaic text on the web.
+
+Have you ever come across a website Mandaic and struggled to understand it? With Mandaic to Hebrew, you no longer have to spend hours deciphering unfamiliar characters. The extension automatically replaces Mandaic characters with the corresponding Hebrew characters, allowing you to read the text with ease.
+
+Whether you're a scholar, researcher, or simply interested in Mandaic culture and history, Mandaic to Hebrew is the perfect tool for simplifying the process of transliterating Mandaic text. Give it a try today and see how it can enhance your Mandaic reading experience!
+
+## Installation
+
+Mandaic to Hebrew can be installed from the Chrome Web Store using the following link (note that it may not be available there yet and will be completed later):
+[link](link) 
+
+To install Mandaic to Hebrew manually, follow these steps:
+
+1.  Clone this repository to your local machine or download the source code as a ZIP file and extract it to a directory.
+2.  Open Chrome and go to `chrome://extensions/`.
+3.  Enable developer mode by toggling the switch in the top right corner of the page.
+4.  Click on the `Load unpacked` button in the top left corner of the page.
+5.  Select the directory containing the source code of Mandaic Transliteration and click `Select`.
+6.  The extension should now be loaded and active in Chrome.
+
+
+## Usage
+
+Mandaic to Hebrew automatically exchanges Mandaic characters with the corresponding Hebrew characters on webpages that contain Mandaic characters. To use the plugin, simply navigate to a webpage that contains Mandaic characters and verify that they have been exchanged with the corresponding Hebrew characters.
+
+For example, you can visit a website like [The Comprehensive Aramaic Lexicon](https://cal.huc.edu/) and open one of the Mandaic texts like [this](https://cal.huc.edu/manget_a_chapter.php?file=74422&sub=107&) and verify that the Mandaic characters on the page have been replaced with the corresponding Hebrew characters.
+
+## Customization
+
+If you wish to customize the mapping function used by Mandaic Transliteration, you can modify the `exchangeCharacters` function in the `content.js` file. Simply change the `syriacLetters` and `hebrewLetters` strings to your desired mapping and reload the extension in Chrome for the changes to take effect.
+
+## License
+
+Mandaic to Hebrew is released under the MIT License. See the `LICENSE` file for more information.
+
+## Contributing
+There are several ways to contribute to the development of the Mandaic to Hebrew Chrome Extension:
+
+* **Code contributions**: If you're interested in contributing to the codebase, feel free to submit a pull request on the GitHub repository.
+* **Bug reports** and **feature requests**: If you come across a bug or have an idea for a new feature, please submit an issue on the [GitHub issue tracker](https://github.com/yanirmr/mandaic-to-hebrew-chrome-extension/issues).
+* **Buy me a coffee**: If you like the extension and want to support its development, you can [buy me a coffee](https://www.buymeacoffee.com/yanirmr).
+
+Thank you for using Mandaic to Hebrew!