Skip to content

Commit

Permalink
doc: Update README.md to rename module and enhance performance descri…
Browse files Browse the repository at this point in the history
…ptions
  • Loading branch information
casualmatt committed Nov 28, 2024
1 parent 685ec80 commit f6f276b
Showing 1 changed file with 26 additions and 25 deletions.
51 changes: 26 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,14 @@ Find and replace all on all files (CMD+SHIFT+F):
- Description: A Nuxt module to fetch and display user country information
-->

# User Country Module
# User Country Detect

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

A Nuxt module to fetch and display user country information.

## Why Use This Module?

When compared to other free alternatives, this module stands out because:
- **It's really fast:** With an average global latency of just 25ms, it's one of the fastest options available.
- **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.
- **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.

<!-- - [✨ &nbsp;Release Notes](/CHANGELOG.md) -->
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/user-country-module?file=playground%2Fapp.vue) -->
<!-- - [📖 &nbsp;Documentation](https://example.com) -->

## Features

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

## Free API service
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.

### Commercial use
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.

### API Rate Limit

We limit requests to 3 requests per second per IP address. If you need a higher rate limit, please contact us.

###

## Quick Setup

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

## Why Use This Module?

When compared to other free alternatives, this module stands out because:
- **Focuses on performance:** With an average global latency of just 25ms, it's one of the fastest options available.
- **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.
- **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.

<!-- - [✨ &nbsp;Release Notes](/CHANGELOG.md) -->
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/user-country-module?file=playground%2Fapp.vue) -->
<!-- - [📖 &nbsp;Documentation](https://example.com) -->


## Free API service
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.

### Commercial use
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.

### API Rate Limit

We limit requests to 3 requests per second per IP address. If you need a higher rate limit, please contact us.

###


## Contribution

<details>
Expand Down

0 comments on commit f6f276b

Please sign in to comment.