diff --git a/README.md b/README.md index 0cdc166..4847556 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ + # IPCheckur -A Minecraft IPCheck tool that allows the operators check the players IP address and their GeoIP locations. + +A Minecraft IP dectection tool that allows the server operators to check the players IP address and their corrsponding GeoIP locations. + + +## Acknowledgements + + - [MIT License](https://github.com/AddictedCoins/IPCheckur/blob/main/LICENSE) + - [MaxMind GeoIP](https://www.maxmind.com/en/geoip2-services-and-databases) + + +## Usage + +To simply check a user's IP address: + +```bash + /ip [USERNAME] +``` + +To check a user's IP address and their GeoIP location: + +```bash + /ipcheckur [USERNAME] +``` + + +## Authors + +- [@AddictedCoins](https://github.com/AddictedCoins)