first push

README.md

@@ -1 +1,49 @@
-# pubg
+\`\`\`markdown
+# DTCH - PUBG Clan User Stats
+
+This project displays the user statistics for members of the DTCH PUBG Clan.
+
+## Features
+
+1. Display lifetime stats for a specific game mode (solo, duo, squad).
+2. Select a player from the DTCH clan and view their stats.
+3. Display the PUBG API rate limit headers.
+
+## Prerequisites
+
+- PHP 7.4 or higher
+- cURL extension for PHP
+
+## Installation
+
+1. Clone this repository:
+   \`\`\`bash
+   git clone [repository-url]
+   \`\`\`
+
+2. Navigate to the project directory:
+   \`\`\`bash
+   cd [project-directory]
+   \`\`\`
+
+3. Update the `config/config.php` file with the appropriate API key and clan members.
+
+4. Host the project on a PHP server (like Apache).
+
+5. Access the `user_stats.php` in your browser to view the stats.
+
+## Usage
+
+1. Select a game mode to view stats (solo, duo, squad).
+2. Choose a clan member to view their specific stats.
+3. The rate limit headers for the PUBG API are displayed at the top.
+
+## Notes
+
+- Ensure that the API key is kept confidential and not exposed to the public.
+- The project comes with a rate limiter (`ratelimiter.php`), which can be included to restrict the frequency of page access.
+
+## License
+
+This project is open-source. Feel free to modify and distribute as per your needs.
+\`\`\`