Fulfill README.md

README.md

@@ -1,2 +1,136 @@
-# polygon-editor
-A tool to create and edit 2D polygons with sprite lookup, created in V
+<h1 align="center">Polygon Editor</h1>
+
+<p align="center">
+  <img src="https://github.com/ArtemkaKun/polygon-editor/assets/36485221/88afe641-bf52-4e08-8df5-7a09860652c5/polygoneditordemo.gif" alt="animated" />
+</p>
+
+## About
+
+Polygon Editor is a desktop application designed for game developers to create and edit 2D polygon shapes to be used as colliders in their games. Compatible with Linux systems, it's built using the [V](https://vlang.io/) programming language and [V UI](https://github.com/vlang/ui) framework, offering a fast and lightweight tool. This project is open-source and is licensed under the MIT license.
+
+## Key Features
+
+- Sprite and Polygon loading: Load sprites (PNG) and existing polygons (JSON) for editing.
+- Polygon drawing: Draw polygons on the loaded sprite by adding points with left mouse clicks.
+- Point modification: Modify polygons by moving the points around.
+- Point deletion: Remove points from the polygon via right-click.
+- Status indications: Display status messages like "Polygon saved", "Sprite opened", etc.
+
+## User Interface
+
+The UI consists of a panel bar at the top and a viewport. The panel bar includes a "File..." button that provides a dropdown menu with options for opening and saving sprites and polygons. The viewport displays the loaded sprite and the drawn polygon.
+
+## Export
+
+Export polygons as JSON files (`Polygon` structure from [v-2d-polygon-colliders](https://github.com/ArtemkaKun/v-2d-polygon-colliders) library). Each point is represented by an object (`Position` structure from [v-2d-transform](https://github.com/ArtemkaKun/v-2d-transform) library) with x and y properties for its coordinates.
+
+```json
+{
+   "points":[
+      {
+         "Vector":{
+            "x":0.05,
+            "y":4.05
+         }
+      },
+      {
+         "Vector":{
+            "x":1.0,
+            "y":2.0
+         }
+      },
+      {
+         "Vector":{
+            "x":3.05,
+            "y":0.0
+         }
+      },
+      {
+         "Vector":{
+            "x":7.0,
+            "y":0.0
+         }
+      },
+      {
+         "Vector":{
+            "x":8.05,
+            "y":1.05
+         }
+      },
+      {
+         "Vector":{
+            "x":9.1,
+            "y":3.05
+         }
+      },
+      {
+         "Vector":{
+            "x":13.05,
+            "y":3.05
+         }
+      },
+      {
+         "Vector":{
+            "x":14.0,
+            "y":4.05
+         }
+      },
+      {
+         "Vector":{
+            "x":15.05,
+            "y":7.0
+         }
+      },
+      {
+         "Vector":{
+            "x":15.05,
+            "y":8.0
+         }
+      },
+      {
+         "Vector":{
+            "x":12.05,
+            "y":11.05
+         }
+      },
+      {
+         "Vector":{
+            "x":9.0,
+            "y":13.0
+         }
+      },
+      {
+         "Vector":{
+            "x":3.05,
+            "y":13.05
+         }
+      },
+      {
+         "Vector":{
+            "x":0.9,
+            "y":9.95
+         }
+      },
+      {
+         "Vector":{
+            "x":0.0,
+            "y":5.0
+         }
+      }
+   ]
+}
+```
+
+## Future Enhancements
+
+- [ ] Dynamic zoom
+- [ ] Undo/redo functionality
+- [ ] Pixel precision grid
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+## Donations
+
+If you like this project, please consider donating to me or the V language project. Your donations will help me to continue to develop this project and the V language.