chore: update README.md (#6)

Reviewed-on: #6
2023-02-01 06:33:56 +00:00 · 2023-02-01 06:33:56 +00:00 · 513dbadb00
parent 5821dbcb0e
commit 513dbadb00
2 changed files with 28 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1,2 +1,29 @@
-# Scripts
+# Tribal Wars - scripts

+This repo contains a variety of scripts for [Tribal Wars](https://www.tribalwars.net/en-dk/).
+
+## Scripts
+
+### Extended player profile
+
+This script adds additional info and actions to a player's profile.
+
+![img.png](docs/extended-player-profile.png)
+
+#### Installation
+
+[User script](https://scripts.tribalwarshelp.com/extended-player-profile.user.js)
+
+Quick bar:
+```javascript
+javascript:
+    $.getScript('https://scripts.tribalwarshelp.com/extended-player-profile.quickbar.js')
+```
+
+## License
+
+Distributed under the MIT License. See ``LICENSE`` for more information.
+
+## Contact
+
+Dawid Wysokiński - [contact@dwysokinski.me](mailto:contact@dwysokinski.me)
--- a/docs/extended-player-profile.png
+++ b/docs/extended-player-profile.png