Skip to content

Commit ed47aad

Browse files
committed
Fix FAQ linkings
1 parent 0c1d5f1 commit ed47aad

File tree

1 file changed

+26
-34
lines changed

1 file changed

+26
-34
lines changed

Diff for: src/pages/faq.md

+26-34
Original file line numberDiff line numberDiff line change
@@ -8,85 +8,77 @@ hide_table_of_contents: true
88

99
- [🔑 How do i get an API Key?](#-how-do-i-get-an-api-key)
1010
- [👨‍💻 I am going to use this API for my company/client project, which email should i use in form?](#-i-am-going-to-use-this-api-for-my-companyclient-project-which-email-should-i-use-in-form)
11-
- [🧐 "Hey, you're taking my personal informations on form", why should i give you?](#-hey-youre-taking-my-personal-informations-on-form-why-should-i-give-you)
12-
- [🕐 How much time it will take to recieve API Key?](#-how-much-time-it-will-take-to-recieve-api-key)
11+
- [🕐 How much time it will take to recieve API Key?](#-how-much-time-it-will-take-to-receive-api-key)
1312
- [🤓 Can i use this API Key for more than one project?](#-can-i-use-this-api-key-for-more-than-one-project)
14-
- [🔞 Is there any restrications on usage or How many requests is allowed per minute?](#-is-there-any-restrications-on-usage-or-how-many-requests-is-allowed-per-minute)
13+
- [🔞 Is there any restrications on usage or How many requests is allowed per minute?](#-are-there-any-restrictions-on-usage-or-how-many-requests-are-allowed-per-minute)
1514
- [🆓 Is this API Free forever?](#-is-this-api-free-forever)
1615
- [🤔 How often data source gets updated?](#-how-often-data-source-gets-updated)
17-
- [🟢 What is the API's uptime?](#-what-is-the-apis-uptime)
18-
- [🧑‍⚖️‍📝 Where can i report data related issues?](#-where-can-i-report-data-related-issues)
19-
- [🍕 "I need something more in response", Where can i submit my request/suggestions?](#-i-need-something-more-in-response-where-can-i-submit-my-requestsuggestions)
16+
- [🟢 What is the API's uptime?](#🟢-what-is-the-apis-uptime)
17+
- [📝 Where can i report data related issues?](#-where-can-i-report-data-related-issues)
18+
- [🍕 I need something more in response, Where can i submit my request/suggestions?](#-i-need-something-more-in-response-where-can-i-submit-my-requestsuggestions)
2019
- [🙏 I am building a plugin/addon/project/app and i need your help.](#-i-am-building-a-pluginaddonprojectapp-and-i-need-your-help)
21-
- [🤷 "I've got a custom question", What should i do?](#-ive-got-a-custom-question-what-should-i-do)
20+
- [🤷 I have got a custom question, What should i do?](#🤷-ive-got-a-custom-question-what-should-i-do)
2221

2322
---
24-
## 🔑 How do i get an API Key?
23+
## 🔑 How do I get an API Key?
2524

2625
You need to fill a form to [Request API Key](https://countrystatecity.in/request).
2726
_(Note: Make sure you fill the form with valid inputs)_.
28-
Request will be reviewed by me and validated manually.
27+
The request will be reviewed by me and validated manually.
2928

3029
---
31-
## 👨‍💻 I am going to use this API for my company/client project, which email should i use in form?
30+
## 👨‍💻 I am going to use this API for my company/client project, which email should I use in form?
3231

33-
You should be using company's official email or client's official email. Because incase in future there will be some announcments to be made via email. The right person should be receiving it.
32+
You should be using the company's official email or the client's official email. It will make sure if any announcement has to be made regarding this API will be reaching the right person. __(Note: We do not share your data with the third party.)__
3433

3534
---
36-
## 🧐 "Hey, you're taking my personal informations on form", why should i give you?
35+
## 🕐 How much time it will take to receive API Key?
3736

38-
Yes, i need this information because in future there will be a dashboard portal where you can login and track your API usages and generate a Key by yourself. __(Note: We do not share your data with third party.)__
37+
Once your API request is approved you will receive an email with API Key. _(Note: Ideal time to receive API key is within a Day or Two)_.
3938

4039
---
41-
## 🕐 How much time it will take to recieve API Key?
40+
## 🤓 Can I use this API Key for more than one project?
4241

43-
Once your API request is approved you will receive an email with API Key. _(Note: Ideal time to recieve API key is within a Day or Two)_.
42+
I should suggest you use a Unique API Key for each project. That will help us easy to migrate to any new system if any to be implemented in near future.
4443

4544
---
46-
## 🤓 Can i use this API Key for more than one project?
45+
## 🔞 Are there any restrictions on usage or How many requests are allowed per minute?
4746

48-
I should suggest you to use a Unique API Key for your each and every project. That will help us easy to migrate to any new system if any to be implemented in near future.
49-
50-
---
51-
## 🔞 Is there any restrications on usage or How many requests is allowed per minute?
52-
53-
No, there are no such limitations has been kept at the moment to usage of API. You can use it freely but use it **Wisely**.
54-
* Try to keep API responses cached for atleast a day. (Since this data is mostly static in nature and updates quite rarely).
55-
* If you're just using this api to leech the data or copy the data to your database then please consider using direct source of database from here. [CountriesStatesCitiesDB](https://github.com/dr5hn/countries-states-cities-database)
47+
No, there are no such limitations that have been kept at the moment to the usage of API. You can use it freely but use it **Wisely**.
48+
* Try to keep API responses cached for at least a day. (Since this data is mostly static in nature and updates quite rarely).
49+
* If you're just using this API to leech the data or copy the data to your database then please consider using a direct source of the database from here. [CountriesStatesCitiesDB](https://github.com/dr5hn/countries-states-cities-database)
5650

5751
---
5852
## 🆓 Is this API Free forever?
5953

60-
TBH, I really want to keep this API Free Forever for the community but sometimes it needs a little bit of support from the users. If this API does helps you earn some bucks, then please try to [Donate](https://countrystatecity.in/donate) atleast 1% of your earning and I am sure that it will be enough to keep this API alive and Free Forever.
54+
TBH, I want to keep this API Free Forever for the community but sometimes it needs a little bit of support from the users. If this API does help you earn some bucks, then please try to [Donate](https://countrystatecity.in/donate) at least 1% of your earning and I am sure that it will be enough to keep this API alive and Free Forever.
6155

6256
---
6357
## 🤔 How often data source gets updated?
6458

65-
I usually try to resolve data issues in bulk and then push data updates all together to this API. So it all depends on the new release of the Database i make on the repo -- [CountriesStatesCitiesDB](https://github.com/dr5hn/countries-states-cities-database)
59+
I usually try to resolve data issues in bulk and then push data updates all together to this API. So it all depends on the new release of the Database I make on the repo -- [CountriesStatesCitiesDB](https://github.com/dr5hn/countries-states-cities-database)
6660

6761
---
6862
## 🟢 What is the API's uptime?
6963

7064
The API has had an uptime of 99.99% throughout the last 12 months. You can review the current status anytime on the Status Page.
7165

7266
---
73-
## 🧑‍⚖️‍📝 Where can i report data related issues?
67+
## 📝 Where can I report data-related issues?
7468

75-
Issues are most welcome. As it makes this database more stronger. Feel free to create issue by using this link - [Report an Issue](https://github.com/dr5hn/countries-states-cities-database/issues/new)
69+
Issues are most welcome. As it makes this database stronger. Feel free to create an issue by using this link - [Report an Issue](https://github.com/dr5hn/countries-states-cities-database/issues/new)
7670

7771
---
78-
## 🍕 "I need something more in response", Where can i submit my request/suggestions?
72+
## 🍕 I need something more in response, Where can I submit my request/suggestions?
7973

8074
You can start raising your request/suggestions here - [Raise a Request](https://github.com/dr5hn/countries-states-cities-database/discussions/151)
8175

8276
---
83-
## 🙏 I am building a plugin/addon/project/app and i need your help.
77+
## 🙏 I am building a plugin/addon/project/app and I need your help.
8478

85-
Well, i hardly get a free time to build a side stuff. But feel free to share your idea, i would be happy to be a part if it's awesome.
79+
Well, I hardly get free time to build side stuff. But feel free to share your idea, I would be happy to be a part if it's awesome.
8680

8781
---
88-
## 🤷 "I've got a custom question", What should i do?
82+
## 🤷 "I've got a custom question", What should I do?
8983

9084
Please feel free to email me at [gadadarshan[at]gmail.com](mailto:[email protected])
91-
92-

0 commit comments

Comments
 (0)