Skip to content

Commit 854ba4c

Browse files
committed
feat: update readme count
1 parent 9abb2de commit 854ba4c

File tree

2 files changed

+40
-8
lines changed

2 files changed

+40
-8
lines changed

.github/CONTRIBUTING.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,42 @@ The following is a set of guidelines for contributing to Contributing to Country
77
## How Can I Contribute?
88
### Fixing Data By Yourself
99
If you want to fix some data and raise a pull request
10-
- To fix cities records - You need to update in `sql/world.sql` > cities Table.
11-
- To fix states/regions records - You need to update in `sql/world.sql` > states Table
12-
- To fix countries records - You need to update in `sql/world.sql` > countries Table
10+
- To fix cities records, update the `sql/world.sql` > cities Table.
11+
- To fix states/provinces records, update the `sql/world.sql` > states Table.
12+
- To fix countries records, update the `sql/world.sql` > countries Table.
13+
- To fix regions records, update the `sql/world.sql` > regions Table.
14+
- To fix subregions records, update the `sql/world.sql` > subregions Table.
1315

1416
## Glance at Table Structure
1517

18+
### regions.sql
19+
| Column | Data type | Explanation | Required |
20+
| ----------------- | --------------- | -------------- | ------------------- |
21+
| `id` | integer | Unique ID used internally, just increment by one when adding entries to the list. | required
22+
| `name` | string | The official name of the region. Use WikiData or Wikipedia or some other legitimate source. | required
23+
| `translations` | text | An array of region name translations |
24+
| `created_at` | timestamp | Set it using NOW() |
25+
| `updated_at` | timestamp | Automatically Updated |
26+
| `flag`| tinyint | 1/0 (automatically set to 1 by default)|
27+
| `wikiDataId` | string | The unique ID from wikiData.org |
28+
29+
### subregions.sql
30+
| Column | Data type | Explanation | Required |
31+
| ----------------- | --------------- | -------------- | ------------------- |
32+
| `id` | integer | Unique ID used internally, just increment by one when adding entries to the list. | required
33+
| `name` | string | The official name of the subregion. Use WikiData or Wikipedia or some other legitimate source. | required
34+
| `translations` | text | An array of subregion name translations |
35+
| `region_id` | string | Unique id of region from `regions.sql` |
36+
| `created_at` | timestamp | Set it using NOW() |
37+
| `updated_at` | timestamp | Automatically Updated |
38+
| `flag`| tinyint | 1/0 (automatically set to 1 by default)|
39+
| `wikiDataId` | string | The unique ID from wikiData.org |
40+
1641
### countries.sql
1742
| Column | Data type | Explanation | Required |
1843
| ----------------- | --------------- | -------------- | ------------------- |
1944
| `id` | integer | Unique ID used internally, just increment by one when adding entries to the list. | required
20-
| `name` | string | The official name of the state. Use WikiData or Wikipedia or some other legitimate source. | required
45+
| `name` | string | The official name of the country. Use WikiData or Wikipedia or some other legitimate source. | required
2146
| `iso2` |char | [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the parent state |
2247
| `iso3` | char | [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the parent country |
2348
| `numeric_code` | char | Source [ISO Official Site](iso.org/obp/ui/#iso:code:3166:NO) |
@@ -28,7 +53,9 @@ If you want to fix some data and raise a pull request
2853
| `tld` | string | Domain code of the country |
2954
| `native` | string | Native name of the country |
3055
| `region` | string | A region where country belongs to |
56+
| `region_id` | string | Unique id of region from `regions.sql` |
3157
| `subregion` | string | A subregion where country belongs to |
58+
| `subregion_id` | string | Unique id of subregion from `subregions.sql` |
3259
| `timezones` | text | An array of timezones |
3360
| `translations` | text | An array of country name translations |
3461
| `latitude` | float | Google Maps |
@@ -61,7 +88,7 @@ If you want to fix some data and raise a pull request
6188
| Column | Data type | Explanation | Required |
6289
| ----------------- | --------------- | -------------- | -------------- |
6390
| `id` | integer | Unique ID used internally, just increment by one when adding entries to the list. | required
64-
| `name` | string | The official name of the state. Use WikiData or Wikipedia or some other legitimate source. | required
91+
| `name` | string | The official name of the city. Use WikiData or Wikipedia or some other legitimate source. | required
6592
| `state_id` | integer | Unique id of parent state from `states.sql` | required
6693
| `state_code` | string | [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the parent state | required
6794
| `country_id` | integer | Unique id of parent country from `countries.sql` | required

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ All Countries, States & Cities are Covered & Populated with Different Combinatio
2323
## Distribution Files Info
2424
File | JSON | SQL | XML | YAML | CSV
2525
:------------ | :-------------| :-------------| :------------- |:-------------|:-------------
26+
Regions | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark:
27+
Subregions | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark:
2628
Countries | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark:
2729
States | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark:
2830
Cities | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark:
@@ -36,11 +38,12 @@ https://dr5hn.github.io/countries-states-cities-database/
3638

3739
## Insights
3840
Total Regions : 6 <br>
41+
Total Sub Regions : 22 <br>
3942
Total Countries : 250 <br>
4043
Total States/Regions/Municipalities : 5,081 <br>
41-
Total Cities/Towns/Districts : 150,541 <br>
44+
Total Cities/Towns/Districts : 150,540 <br>
4245

43-
Last Updated On : 11th Aug 2023
46+
Last Updated On : 3rd Sept 2023
4447

4548
## Next API Database Update
4649

@@ -66,8 +69,10 @@ If you want to contribute to the database, please follow the guidelines outlined
6669
- Fork the repository and clone it to your local machine.
6770
- Make the necessary changes to the data:
6871
- To fix cities records, update the `sql/world.sql` > cities Table.
69-
- To fix states/regions records, update the `sql/world.sql` > states Table.
72+
- To fix states/provinces records, update the `sql/world.sql` > states Table.
7073
- To fix countries records, update the `sql/world.sql` > countries Table.
74+
- To fix regions records, update the `sql/world.sql` > regions Table.
75+
- To fix subregions records, update the `sql/world.sql` > subregions Table.
7176
- Once you've made the changes, create a pull request with a clear description of the modifications you've made.
7277

7378
Please make sure to review the guidelines before making any contributions. They will help ensure that your contributions align with the project's standards and make the process smoother for everyone involved.

0 commit comments

Comments
 (0)