Skip to content

Commit 7c4253a

Browse files
committed
docs: update README - font size and text content
1 parent 9c1696e commit 7c4253a

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,17 @@ The following dependencies are used for this project. Feel free to use other dep
6565
- Checkout the excel file format on the `/app/data/day1.xlsx` sample file for more information
6666
5. (Optional) Download URL for a remote excel file.
6767
- See the `EXCEL_FILE_URL` variable on the [Installation](#installation) section.
68+
6. (Optional) Docker
69+
- Use Docker for localhost development
70+
- See the [Docker Dependencies](#docker-dependencies) section for more information.
6871

6972
</details>
7073

7174
<span id="faqs"></span>
7275
## FAQs
7376

7477
<details>
75-
<summary style="color: #808080; font-size: 24px;">
78+
<summary style="color: #808080; font-size: 22px;">
7679
<b>What is the purpose or goal of ph-municipalities?</b>
7780
</summary>
7881

@@ -89,7 +92,7 @@ Its early stages were written as procedural functions within a _private backend
8992
<br>
9093

9194
<details>
92-
<summary style="color: #808080; font-size: 24px;">
95+
<summary style="color: #808080; font-size: 22px;">
9396
<b>Can ph-municipalities parse and extract PAGASA 10-day weather forecast data?</b>
9497
</summary>
9598

@@ -104,7 +107,7 @@ ph-municipalities only have class methods for parsing, extracting, listing and q
104107
<br>
105108

106109
<details>
107-
<summary style="color: #808080; font-size: 24px;" id="similar-libraries">
110+
<summary style="color: #808080; font-size: 22px;" id="similar-libraries">
108111
<b>Are there alternative libraries to ph-municipalities for listing Philippine provinces and municipalities?</b>
109112
</summary>
110113

@@ -129,15 +132,15 @@ Note, however, that these items use old and new data sources. These may not be f
129132
<br>
130133

131134
<details>
132-
<summary style="color: #808080; font-size: 24px;">
135+
<summary style="color: #808080; font-size: 22px;">
133136
<b>Is it possible to make ph-municipalities parse and extract PAGASA 10-day weather forecast data?</b>
134137
</summary>
135138

136139
<br>
137140

138141
While ph-municipalites do not support parsing and extracting PAGASA 10-day weather forecast data, _you can extend the `ExcelFile` or `ExcelFactory` classes with custom logic and codes to enable parsing and extracting PAGASA 10-day weather forecast data_.
139142

140-
Since the `ExcelFile` or `ExcelFactory` are [classes](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes) (functions in disguise, not true OOP, but inheritance still works), you can extend them with class inheritance, overriding or creating new class methods to accommodate processing the PAGASA 10-day weather forecast data. Refer to the [ph-municipalities class documentation](https://ciatph.github.io/ph-municipalities) to know more about the available classes, member variables, and methods.
143+
Since the `ExcelFile` or `ExcelFactory` are JavaScript [Classes](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes) (Functions in disguise, not true OOP, but inheritance still works), you can extend them with class inheritance, overriding or creating new class methods to accommodate processing the PAGASA 10-day weather forecast data. Refer to the [ph-municipalities class documentation](https://ciatph.github.io/ph-municipalities) to know more about the available classes, member variables, and methods.
141144

142145
An example of extending the classes to parse PAGASA 10-day weather forecast data may go along the lines of:
143146

@@ -174,8 +177,8 @@ weatherForecast = parser.getWeatherData()
174177
<br>
175178

176179
<details>
177-
<summary style="color: #808080; font-size: 24px;">
178-
<span style="color: #808080; font-size: 24px;">
180+
<summary style="color: #808080; font-size: 22px;">
181+
<span style="color: #808080; font-size: 22px;">
179182
<b>How does ph-municipalities determine which provinces belong to a region?</b>
180183
</span>
181184
</summary>
@@ -196,18 +199,18 @@ This file contains region/province names mapping encoded manually with reference
196199
<br>
197200

198201
<details>
199-
<summary style="color: #808080; font-size: 24px;">
200-
<span style="color: #808080; font-size: 24px;">
201-
<b>Are the provinces and municipality list generated by ph-municipalities updated?</b>
202+
<summary style="color: #808080; font-size: 22px;">
203+
<span style="color: #808080; font-size: 22px;">
204+
<b>Are the provinces and municipality lists generated by ph-municipalities updated?</b>
202205
</span>
203206
</summary>
204207

205208
<br>
206209

207-
NO. By default, ph-municipalities use an outdated PAGASA 10-day Excel file by default for its local data source, downloaded on August 8, 2022. However, it also provides several ways for using updated PAGASA 10-day Excel files as data sources by:
210+
NO. By default, ph-municipalities use an outdated PAGASA 10-day Excel file for its local data source, downloaded on August 8, 2022. However, it also provides several ways for using updated PAGASA 10-day Excel files as data sources:
208211

209212
- Prompting to download an updated PAGASA 10-day Excel file using the [Interactive CLI Scripts](#interactive-cli-scripts)
210-
- Providing [class methods](https://ciatph.github.io/ph-municipalities/ExcelFile.html#download) to programmatically download and use a remote PAGASA 10-day Excel file
213+
- Providing [class methods](https://ciatph.github.io/ph-municipalities/ExcelFile.html#download) for programmatically downloading and using a remote PAGASA 10-day Excel file
211214
- Allowing to override the default region - province list settings during class initialization (See [Class Usage - Using a Custom Configuration File](#using-a-custom-configuration-file))
212215

213216
> **NOTE:**<br>
@@ -452,7 +455,7 @@ npm run list:region
452455
453456
Builds the class documentation into the **/docs** directory.
454457
455-
> [!NOTE]
458+
> **NOTE:**<br>
456459
> This script requires manual installation of the `jsdoc@4.0.3`, `minami@1.2.3`, and `taffydb@2.7.3` packages as **devDependencies** inside the **/app** directory.
457460
> These libraries, only used for building the class documentation, were excluded from the final package.json to have fewer external dependencies.
458461
> ```bash
@@ -464,7 +467,7 @@ Builds the class documentation into the **/docs** directory.
464467
465468
Runs the Bash script that installs the JSDoc and theme dependencies for building the class documentation only within the **development Docker environment**.
466469
467-
> [!NOTE]
470+
> **NOTE:**<br>
468471
> This script requires running from a Bash terminal - it won't work from a Windows command line terminal. It is reserved for building the documentation with Docker.
469472
470473
This script is used for building the class documentation from a local Docker environment along with the `npm run docs:build` NPM script.
@@ -478,7 +481,7 @@ docker exec -u root -it ph-municipalities npm run docs:build
478481

479482
Runs the Bash script that builds the class documentation using JSDoc only within the **development Docker environment**.
480483

481-
> [!NOTE]
484+
> **NOTE:**<br>
482485
> This script requires running from a Bash terminal - it won't work from a Windows command line terminal. It is reserved for building the documentation with Docker.
483486
484487
This script is used for building the class documentation from a local Docker environment along with the `npm run docs:install` NPM script.

0 commit comments

Comments
 (0)