Embedding andaluhgs as part of the gwao script. Adding a Add-On homep…

…age using CardService.

README.md

@@ -1,6 +1,6 @@
 # andaluh-googledocs-addon
 
-A side panel add-on for Google Docs (Google Drive) to help you transliterating español (spanish) spelling to andaluz proposals. It imports [andaluh-gs](https://github.com/andalugeeks/andaluh-js/tree/google-apps-script) library, already hosted at Google Apps Script.
+A side panel add-on for Google Docs (Google Drive) to help you transliterating español (spanish) spelling to andaluz proposals. It uses a fork from [andaluh-gs](https://github.com/andalugeeks/andaluh-js/tree/google-apps-script) library, already embedded under `src/andaluhgs`.
 
 <a href="https://youtu.be/cqScVjWM1EU"><img width="800" alt="andaluh-gs about" src="https://raw.githubusercontent.com/andalugeeks/andaluh-googledocs-addon/main/img/andaluh-googledocs.png"></a>
 
@@ -61,11 +61,13 @@ Note the two links prompted. Push the source code to the google apps script proj
 $ clasp push
 (node:1428508) ExperimentalWarning: The fs.promises API is experimental
 ? Manifest file has been updated. Do you want to push and overwrite? Yes
-└─ appsscript.json
-└─ main.js
-└─ sidebar.html
-└─ test.js
-Pushed 4 files.
+└─ src/andaluhgs/epa.js
+└─ src/andaluhgs/util.js
+└─ src/appsscript.json
+└─ src/main.js
+└─ src/sidebar.html
+└─ src/test.js
+Pushed 6 files.
 ```
 
 Go open the `google docs` file. Use the link prompted upon `clasp create`.
@@ -78,9 +80,10 @@ Have a look at the featured video. Click for fullscreen:
 
 ## Development
 
-To use a different [andaluh-gs](https://github.com/andalugeeks/andaluh-js/tree/google-apps-script) transcription library version, deploy your own copy on your Google App Script account. Then edit the `appscript.json` file to reference your own version and follow the installation steps from step 1.
+To use a different [andaluh-gs](https://github.com/andalugeeks/andaluh-js/tree/google-apps-script) transcription library version you've two options
 
-Further reference on how to edit the `appscript.json` file here: https://developers.google.com/apps-script/manifest/dependencies
+* Edit the files under `src/andaluhgs`
+* Deploy your own `andaluhgs` as a Google App Script. Then remove the files under `src/andaluhgs` and add your own `andaluhgs` library as a dependency on the `appscript.json` file (further reference on how to edit the `appscript.json` file here: https://developers.google.com/apps-script/manifest/dependencies).
 
 ## Roadmap
 

src/andaluhgs/README.md

@@ -0,0 +1,67 @@
+# Andaluh-gs
+
+Google Apps Script implementation for [andaluh-js](https://github.com/andalugeeks/andaluh-js). Transliterate español (spanish) spelling to andaluz proposals.
+
+<img width="800" alt="andaluh-gs about" src="https://github.com/andalugeeks/andaluh-js/raw/google-apps-script/img/andaluh-gs.png?raw=true">
+
+## Table of Contents
+
+- [Description](#description)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Roadmap](#roadmap)
+- [Support](#support)
+- [Contributing](#contributing)
+
+## Description
+
+The **Andalusian varieties of [Spanish]** (Spanish: *andaluz*; Andalusian) are spoken in Andalusia, Ceuta, Melilla, and Gibraltar. They include perhaps the most distinct of the southern variants of peninsular Spanish, differing in many respects from northern varieties, and also from Standard Spanish. Further info: https://en.wikipedia.org/wiki/Andalusian_Spanish.
+
+This package introduces transliteration functions to convert *español* (spanish) spelling to andaluz. As there's no official or standard andaluz spelling, andaluh-js is adopting the **EPA proposal (Er Prinzipito Andaluh)**. Further info: https://andaluhepa.wordpress.com. Other andaluz spelling proposals are planned to be added as well.
+
+## Installation
+
+Just upload the `andalu/*js` files into your Google Apps Script project, or automate with Google Apps Script `clasp` tool. The benefit of the second approach is you can keep developing locally your `andaluh-gs` based project instead of using the Google Apps Script web IDE.
+
+```
+$ npm install -g @google/clasp
+```
+
+Install the google apps script type definitions as well:
+
+```
+$ npm i -S @types/google-apps-script
+```
+
+Login and push!
+
+```
+$ clasp login
+$ clasp push
+```
+
+## Usage
+
+Have a look at the following snippet
+
+```javascript
+const andaluhEPA = new EPA();
+console.log(andaluhEPA.transcript('El veloz murciélago hindú comía feliz cardillo y kiwi. La cigüeña tocaba el saxofón detrás del palenque de paja'));
+// Er belôh murçiélago indú comía felîh cardiyo y kiwi. La çigueña tocaba er çâççofón detrâh der palenque de paha.
+```
+
+## Roadmap
+
+* Adding more andaluh spelling proposals.
+* Contractions and inter-word interaction rules pending to be implemented.
+* Silent /h/ sounds spelling rules pending to be implemented.
+* Some spelling intervowel /d/ rules are still pending to be implemented.
+* Transliteration rules for some consonant ending words still pending to be implemented.
+
+## Support
+
+Please [open an issue](https://github.com/andalugeeks/andaluh-js/issues/new) for support.
+
+## Contributing
+
+Please contribute using [Github Flow](https://guides.github.com/introduction/flow/). Create a branch, add commits, and open a pull request.