Skip to content

Commit f6f276b

Browse files
committed
doc: Update README.md to rename module and enhance performance descriptions
1 parent 685ec80 commit f6f276b

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

README.md

+26-25
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,14 @@ Find and replace all on all files (CMD+SHIFT+F):
77
- Description: A Nuxt module to fetch and display user country information
88
-->
99

10-
# User Country Module
10+
# User Country Detect
1111

1212
[![npm version][npm-version-src]][npm-version-href]
1313
[![npm downloads][npm-downloads-src]][npm-downloads-href]
1414
[![License][license-src]][license-href]
1515
[![Nuxt][nuxt-src]][nuxt-href]
1616

1717
A Nuxt module to fetch and display user country information.
18-
19-
## Why Use This Module?
20-
21-
When compared to other free alternatives, this module stands out because:
22-
- **It's really fast:** With an average global latency of just 25ms, it's one of the fastest options available.
23-
- **Effective localization suggestions:** It works well to suggest changing the user's country or language/currency based on their location, making it ideal for enhancing the user experience.
24-
- **No browser location sharing required:** Unlike some other solutions, it doesn't require the user to share their precise browser location, ensuring better privacy while still delivering accurate information.
25-
26-
<!-- - [✨ &nbsp;Release Notes](/CHANGELOG.md) -->
27-
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/user-country-module?file=playground%2Fapp.vue) -->
28-
<!-- - [📖 &nbsp;Documentation](https://example.com) -->
29-
3018
## Features
3119

3220
<!-- Highlight some of the features your module provide here -->
@@ -35,18 +23,6 @@ When compared to other free alternatives, this module stands out because:
3523
- 🗺️ &nbsp;Supports 250 countries, autonomous regions, ...
3624
-&nbsp;Extremely fast detection and response time.
3725

38-
## Free API service
39-
The module bases its detection on a network of 119 PoP, with an average global latency of 25ms. The API is offered by JAMflow.cloud and is free to use, without any guarantee. We will limit IP or website that will spam or abuse the service.
40-
41-
### Commercial use
42-
You are allowed to use the service for any commercial use, but you are not allowed to resell it without an agreement with us beforehand.
43-
44-
### API Rate Limit
45-
46-
We limit requests to 3 requests per second per IP address. If you need a higher rate limit, please contact us.
47-
48-
###
49-
5026
## Quick Setup
5127

5228
Install the module to your Nuxt application with one command:
@@ -86,6 +62,31 @@ const { data, refresh, status } = await useUserCountry();
8662
- `refresh`: Function to refresh the country information.
8763
- `status`: The status of the fetch request (`'idle'`, `'loading'`, `'success'`, `'error'`).
8864

65+
## Why Use This Module?
66+
67+
When compared to other free alternatives, this module stands out because:
68+
- **Focuses on performance:** With an average global latency of just 25ms, it's one of the fastest options available.
69+
- **Effective localization suggestions:** It works well to suggest changing the user's country or language/currency based on their location, making it ideal for enhancing the user experience.
70+
- **No browser location sharing required:** Unlike some other solutions, it doesn't require the user to share their precise browser location, ensuring better privacy while still delivering accurate information.
71+
72+
<!-- - [✨ &nbsp;Release Notes](/CHANGELOG.md) -->
73+
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/user-country-module?file=playground%2Fapp.vue) -->
74+
<!-- - [📖 &nbsp;Documentation](https://example.com) -->
75+
76+
77+
## Free API service
78+
The module bases its detection on a network of 119 PoP, with an average global latency of 25ms. The API is offered by JAMflow.cloud and is free to use, without any guarantee currently. We will limit IP or website that will spam or abuse the service.
79+
80+
### Commercial use
81+
You are allowed to use the service for any commercial use, but you are not allowed to resell it without an agreement with us beforehand.
82+
83+
### API Rate Limit
84+
85+
We limit requests to 3 requests per second per IP address. If you need a higher rate limit, please contact us.
86+
87+
###
88+
89+
8990
## Contribution
9091

9192
<details>

0 commit comments

Comments
 (0)