From 690c0f64877131ecc8c2ec5af9f571e51ad542cf Mon Sep 17 00:00:00 2001
From: ghost <localhost>
Date: Sun, 7 Jan 2024 00:27:17 +0200
Subject: [PATCH] update readme

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/README.md b/README.md
index fa55c08..92b161f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,50 @@
 # HLState
+
 Web Stats for Half-Life Server
+
+## Install
+
+* `git clone https://github.com/YGGverse/HLState.git`
+* `cd HLState`
+* `composer install`
+
+### Setup
+
+* `cp .env .env.local`
+* `php bin/console doctrine:database:create`
+* `crontab -e`
+  + `* * * * * /usr/bin/curl --silent http://address/crontab/online &> /dev/null`
+
+## Update
+
+* `composer update`
+* `php bin/console doctrine:migrations:migrate`
+* `php bin/console cache:clear`
+
+## License
+
+* Engine sources [MIT License](https://github.com/YGGverse/HLState/blob/main/LICENSE)
+
+## Versioning
+
+[Semantic Versioning 2.0.0](https://semver.org/#semantic-versioning-200)
+
+## Components
+
+* [Symfony Framework](https://symfony.com)
+* [SVG icons](https://icons.getbootstrap.com)
+* [PHP Source Query](https://github.com/xPaw/PHP-Source-Query)
+
+## Support
+
+* [Issues](https://github.com/YGGverse/HLState/issues)
+
+## Blog
+
+* [Mastodon](https://mastodon.social/@YGGverse)
+
+## See also
+
+* [HLServers - Half-Life Servers Registry for HLState](https://github.com/YGGverse/HLServers)
+* [half-life-server - Half-Life server edition by YGGverse](https://github.com/YGGverse/half-life-server)
+* [pymaster - Refactored master server written in Python](https://github.com/YGGverse/pymaster)
\ No newline at end of file