Skip to content

Commit acb7a83

Browse files
committed
revise readme for clarity and brevity and update pkg version
1 parent 14a8b5e commit acb7a83

File tree

2 files changed

+14
-28
lines changed

2 files changed

+14
-28
lines changed

README.md

Lines changed: 13 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,11 @@ municipalities, locations, and regions. Moreover, searching within the library i
1515

1616
* [Installation](#installation)
1717
* [Usage](#usage)
18-
* [Return Values](#return-values)
18+
* [Demo](#demo)
19+
* [Importing Types](#importing-types)
20+
* [Type Definitions](#type-definitions)
1921
* [Query Options](#query-options)
2022
* [ECMAScript Module (ESM) Entry Point](#ecmascript-module-esm-entry-point)
21-
* [Demo](#demo)
2223
* [Contribution Guidelines](#contribution-guidelines)
2324
* [License](#license)
2425

@@ -107,6 +108,13 @@ const dataList = postalPH.fetchDataLists({
107108
console.log(dataList);
108109
```
109110

111+
## Demo
112+
113+
Explore the live demo to experience fetching and searching functionalities for municipalities, post codes, locations,
114+
and regions. Interact with the application to witness its efficiency and responsiveness in action.
115+
116+
https://use-postal-ph.vercel.app
117+
110118
## Importing Types
111119

112120
You can also import specific types provided by use-postal-ph:
@@ -142,21 +150,6 @@ export type PlaceListCriteriaProps = PlaceProps & {
142150
};
143151
```
144152

145-
## Return Values
146-
147-
When fetching data, the function returns either an array of objects or an array of strings, depending on the method
148-
used:
149-
150-
- If the method returns an array of objects:
151-
- Each object represents a place and includes the following properties:
152-
- `municipality`: The name of the municipality.
153-
- `location`: The specific district or neighborhood.
154-
- `post_code`: The specific postal code assigned to the location.
155-
- `region`: The region where the place is located.
156-
157-
- If the method returns an array of strings or numbers:
158-
- Each string or number represents a specific piece of information, such as a postal code, location, or region.
159-
160153
## Query Options
161154

162155
When using the library's methods, you have the option to include an object containing parameters for more specific
@@ -179,14 +172,14 @@ If you prefer not to install the package and want to include the ECMAScript modu
179172
project, you can use the following script tag:
180173

181174
- CDN (
182-
jsDelivr): [`https://cdn.jsdelivr.net/npm/use-postal-ph@1.1.2/dist/index.mjs`](https://cdn.jsdelivr.net/npm/use-postal-ph@1.1.2/dist/index.mjs)
175+
jsDelivr): [`https://cdn.jsdelivr.net/npm/use-postal-ph@1.1.3/dist/index.mjs`](https://cdn.jsdelivr.net/npm/use-postal-ph@1.1.3/dist/index.mjs)
183176

184-
- npm: [`https://unpkg.com/use-postal-ph@1.1.2/dist/index.mjs`](https://unpkg.com/use-postal-ph@1.1.2/dist/index.mjs)
177+
- npm: [`https://unpkg.com/use-postal-ph@1.1.3/dist/index.mjs`](https://unpkg.com/use-postal-ph@1.1.3/dist/index.mjs)
185178

186179
```html
187180

188181
<script type="module">
189-
import usePostalPH from 'https://unpkg.com/use-postal-ph@1.1.2/dist/index.mjs';
182+
import usePostalPH from 'https://unpkg.com/use-postal-ph@1.1.3/dist/index.mjs';
190183
191184
const {
192185
fetchDataLists,
@@ -212,13 +205,6 @@ postal code '6045'. It then logs the result to the console.
212205
}
213206
```
214207

215-
## Demo
216-
217-
Explore the live demo to experience fetching and searching functionalities for municipalities, post codes, locations,
218-
and regions. Interact with the application to witness its efficiency and responsiveness in action.
219-
220-
https://use-postal-ph.vercel.app
221-
222208
## Contribution Guidelines
223209

224210
Contributions are highly appreciated! To contribute, fork the repository, create a new branch for your changes, and

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "use-postal-ph",
3-
"version": "1.1.2",
3+
"version": "1.1.3",
44
"description": "This utility library is specifically designed for the Philippines, providing comprehensive information on postal codes,\nmunicipalities, locations, and regions. Moreover, searching within the library is case insensitive.",
55
"main": "./dist/index.js",
66
"module": "./dist/index.mjs",

0 commit comments

Comments
 (0)