Merge pull request #98 from ciatph/dev

v1.3.5

.github/workflows/release.yml

@@ -117,6 +117,8 @@ jobs:
     name: Publish to NPM registry
     runs-on: ubuntu-latest
     needs: build-on-win
+    env:
+      IMAGE_URL: ${{ secrets.IMAGE_URL }}
     steps:
       - name: Checkout the repository
         uses: actions/checkout@v3

README.md

@@ -102,6 +102,7 @@ The following dependencies are used for this project. Feel free to use other dep
    | SHEETJS_COLUMN    | Column name read by [sheetjs](https://sheetjs.com/) in an excel file.<br>This column contains the municipality and province names following the string pattern<br>`"municipalityName (provinceName)"`<br>Default value is `__EMPTY`|
    | SORT_ALPHABETICAL | Arranges the municipality names in alphabetical order.<br>Default value is `1`. Set to `0` to use the ordering as read from the Excel file. |
    | SPECIAL_CHARACTERS | Key-value pairs of special characters or garbled text and their normalized text conversions, delimited by the `":"` character.<br>Multiple key-value pairs are delimited by the `","` character.<br>If a special character key's value is a an empty string, write it as i.e.,: `"some-garbled-text:"` |
+   | IMAGE_URL | Raw URL of the README image file from this GitHub repository.<br> <blockquote>**NOTE:** Only add this variable in the GitHub Secrets for publishing to the NPM registry since NPM does not allow displaying images by relative path.</blockquote> |
 
 ## Installation Using Docker
 

app/.env.example

@@ -2,4 +2,5 @@ EXCEL_FILE_URL=https://pubfiles.pagasa.dost.gov.ph/pagasaweb/files/climate/tenda
 DEFAULT_EXCEL_FILE_URL=https://pubfiles.pagasa.dost.gov.ph/pagasaweb/files/climate/tendayweatheroutlook/day1.xlsx
 SHEETJS_COLUMN=__EMPTY
 SORT_ALPHABETICAL=1
-SPECIAL_CHARACTERS=├â┬▒:ñ,â:
+SPECIAL_CHARACTERS=├â┬▒:ñ,â:
+IMAGE_URL=https://raw.githubusercontent.com/ciatph/ph-municipalities/master/docs/diagrams/ph-municipalities-arch-90.png

app/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ph-municipalities",
-  "version": "1.3.4",
+  "version": "1.3.5",
   "description": "List and write the `municipalities` of Philippines provinces or regions into JSON files",
   "main": "index.js",
   "engines": {

scripts/npm-publish.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
 
-sed "s|/docs/diagrams/||g" README.md > app/README.md
-cp docs/diagrams/ph-municipalities-arch-90.png app/
+# Use image file from remote URL source since NPM does not allow displaying images by relative path
+sed "s|/docs/diagrams/ph-municipalities-arch-90.png|${IMAGE_URL}|g" README.md > app/README.md