Skip to content

Commit cd7de61

Browse files
committed
updated readme
1 parent 9088cac commit cd7de61

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Retrieve all countries with cities
99
+ [Get cities](#get-cities)
1010

1111
## Features
12-
+ Get names,codes and cities of all countries
12+
+ Get names, codes and cities of all countries
1313
+ Filter cities by country name, country code, continent name
1414

1515
## Installing
@@ -22,7 +22,7 @@ OR
2222
yarn add countries-with-cities-select
2323
2424
```
25-
Once the package is installed you use the require approach
25+
Once the package is installed you use the require/import approach
2626

2727
```javascript
2828
const countriesWithCities = require('countries-with-cities-select');
@@ -43,7 +43,7 @@ declare module 'countries-with-cities-select'
4343
```
4444
4545
## #Get countries
46-
This will all countries.
46+
This will list all countries.
4747
```javascript
4848

4949
const countriesWithCities = require('countries-with-cities-select');
@@ -53,7 +53,7 @@ countriesWithCities.getCountries();
5353
```
5454

5555
## #Get countries with details
56-
This will retrieve information about countries with code, continent etc.
56+
This will retrieve information about countries with code, continent etc. Filter by country name, country code or continent
5757
```javascript
5858

5959
const countriesWithCities = require('countries-with-cities-select');
@@ -69,7 +69,8 @@ countriesWithCities.getCountriesWithDetails("africa");
6969
```
7070

7171
## #Get cities
72-
This will retrieve information about cities. Filter with country name, code or continent
72+
This will retrieve information about cities. Filter with country name, country code or continent
73+
Empty filter will return no cities
7374

7475
```javascript
7576
const countriesWithCities = require('countries-with-cities-select');

0 commit comments

Comments
 (0)