starting some docs

Author: erickzanardo

README.md

@@ -1,17 +1,28 @@
 # Typled
 
-Typled is a text based map tool. It uses a simple format where characters are mapped to a texture
-and then the "position" of the character in the text is used to determine the position of the
+Typled is a text based map tool. It uses a simple format where characters are mapped to a texture.
+
+The "position" of the character in the text is used to determine the position of the
 texture in the map.
 
-For example, lets say we have `G` mapped to grass tile and W mapped to water tile. So for example:
+Creating typled maps is just editing a simple text file, so users can choose any text editors
+they like.
 
-```
-GWG
-GWG
-GWG
+A simple CLI is also provided, which allow users to install and use the previewer app, which
+shows the rendered map in a simple desktop application.
+
+![](./docs/typled.gif)
+
+To install the CLI, run:
+
+```bash
+dart pub global activate typled_cli
 ```
 
-Define a 3x3 map with a river on the middle and grass on the sides.
+Typled currently supports:
+ - Individual maps with multiple layers
+ - Grid of maps, where each map is a cell in the grid
+ - Out of the box Texture Atlas format
+ - [Fire Atlas textures format](https://docs.flame-engine.org/latest/bridge_packages/flame_fire_atlas/fire_atlas.html).
 
-TODO
+ For more information check out the [docs](./docs/README.md).

docs/README.md

@@ -0,0 +1,3 @@
+this is the docs
+
+TODO