From ab02adb2df8edd794c036547fb61e7f904da780c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Zurcher?= <jeremy@asynk.ch>
Date: Thu, 18 Oct 2018 11:37:41 +0200
Subject: README, TODO

---
 README.md | 33 ++++++++++-----------------------
 TODO.md   | 11 +++++++++++
 2 files changed, 21 insertions(+), 23 deletions(-)
 create mode 100644 TODO.md

diff --git a/README.md b/README.md
index cfb46e7..928bdce 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,12 @@
-# this file is currently used as task reminder
+# gdx-boardgame
 
-## TODO
- - UI widgets
-    - list
-    - scrollbale vert/horiz 
- - Pawn Animations
- - Algos
-    - Distance
-    - Adjacents
-    - Line Of Sight
-    - Reachable Tiles ::: BFS
-    - Shortest Path ::: A*
- - CircleMap
+is a [libgdx](https://libgdx.badlogicgames.com/) based framework to build 2D boardgames.
+
+
+## features
+
+    - moveable, zoomable board with tile identification on touch
+    - moveable, orientable pieces
+    - various animations
+    - path, movement, line of sight computation
 
-## DONE
- - SquareMap
- - HexMap
- - TriangleMap
- - UI widgets
- - GameScreen
- - BoardCamera
- - Assets
- - LoadingScreen
- - Fonts
diff --git a/TODO.md b/TODO.md
new file mode 100644
index 0000000..c6ae8c7
--- /dev/null
+++ b/TODO.md
@@ -0,0 +1,11 @@
+## TODO
+ - UI widgets
+    - list
+    - scrollbale vert/horiz
+ - Algos
+    - Distance
+    - Adjacents
+    - Line Of Sight
+    - Reachable Tiles ::: BFS
+    - Shortest Path ::: A*
+ - CircleMap
-- 
cgit v1.1-2-g2b99