Skip to content

Commit

Permalink
docs: use more details/summary in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
ciatph committed Sep 12, 2024
1 parent 348fd83 commit 7f16bf6
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@ Below are example usages of the `ExcelFile` class, run from the **/app/src/examp
This is a simple usage example of the `ExcelFile` class.

<details>
<summary><b>Simple Usage</b></summary>
<summary>Simple Usage</summary>

```javascript
const path = require('path')
Expand Down Expand Up @@ -415,7 +415,7 @@ file.datalist = [

<details>
<summary>
<b>Reading regions, provinces and municipalities</b>
Reading regions, provinces and municipalities
</summary>

```javascript
Expand Down Expand Up @@ -456,7 +456,7 @@ Adding a `url` field in the constructor parameter prepares the class to downlo

<details>
<summary>
<b>Remote Excel file download example</b>
Remote Excel file download example
</summary>

> **INFO:** Run the `.init()` method after initializing a class with a `url` parameter to start the async file download.
Expand Down Expand Up @@ -494,7 +494,7 @@ main()

<details>
<summary>
<b>Initialize an ExcelFile class instance.</b>
Initialize an ExcelFile class instance
</summary>

```javascript
Expand Down Expand Up @@ -541,7 +541,7 @@ Follow the codes to define a custom regions config file, following the format of
<details>
<summary>
<b>config.json</b>
config.json
</summary>

```
Expand Down Expand Up @@ -578,7 +578,7 @@ Follow the codes to define a custom regions config file, following the format of

<details>
<summary>
<b>Custom config usage</b>
Custom config usage
</summary>

```javascript
Expand Down Expand Up @@ -617,7 +617,10 @@ console.log('---municipalities', municipalities)

## Building Standalone Windows Executables

The main npm scripts can be packaged into standalone windows executables. Pre-compiled windows binaries are available for download in the latest [Releases](https://github.com/ciatph/ph-municipalities/releases) download page.
<details>
<summary>
The main npm scripts can be packaged into standalone windows executables. Pre-compiled windows binaries are available for download in the latest <a href="https://github.com/ciatph/ph-municipalities/releases">Releases</a> download page.
</summary>

1. Run any of the following scripts to build the programs.
```bash
Expand All @@ -627,9 +630,14 @@ The main npm scripts can be packaged into standalone windows executables. Pre-co
```
2. Click the resulting executable files in the `/dist` directory to execute.

</details>

## Compiling into Single, Minified Files

<details>
<summary>
The main npm scripts can be compiled into standalone JavaScript files together with all its dependencies.
</summary>

1. Run any of the following scripts to compile the source codes.
```bash
Expand All @@ -643,6 +651,8 @@ The main npm scripts can be compiled into standalone JavaScript files together w
node dist/province
```

</details>

## Building the Class Documentation

The class documentation uses [JSDoc](https://jsdoc.app/) annotations where applicable in the JavaScript source codes inside the **/src** directory. There are two (2) options for building the class documentation.
Expand Down

0 comments on commit 7f16bf6

Please sign in to comment.