add readme

README.md

@@ -1,36 +1,18 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# CS2 Server Dashboard
 
-## Getting Started
+## Overview
 
-First, run the development server:
+A very basic CounterStrike 2 Server Dashboard!
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+## Features
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+- **Connected Players**: Monitor all players with details like ping, packet loss, name, and IP.
+- **IP Lookup**: Optionally view IP details such as country, city, ASN, and ASN number.
+- **Kick Players**: A quick and easy way to kick players.
+- **Console**: Execute RCON commands with some basic auto-complete suggestions.
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+## Installation
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
-
-## Learn More
-
-To learn more about Next.js, take a look at the following resources:
-
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
-
-## Deploy on Vercel
-
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+The recommended way to use this using docker and docker-compose. I have provided 2 example docker-compose files.
+1) [Standalone](https://github.com/LoV432/cs2-dashboard/blob/master/examples/docker-compose.yml)
+2) [Dashboard with CS2](https://github.com/LoV432/cs2-dashboard/blob/master/examples/docker-compose-with-cs2.yml)