From 2dd85171d56f95b381d38649e351f6afdcd21cfa Mon Sep 17 00:00:00 2001
From: Lukáš Růžička <lruzicka@redhat.com>
Date: Jun 15 2020 10:10:25 +0000
Subject: Add to README.


---

diff --git a/README.md b/README.md
index 0bc3f1f..e5da7e4 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
-# autococonut
+# AutoCoconut, a creative tool for OpenQA
+
+**AutoCoconut** is a tool that runs in the background and records keyboard and mouse events
+and then turns them into a list of events (or a workflow) and creates screenshots for each
+of the events.
+
+Such information can be helpful when creating test cases for GUI testing frameworks,
+such as OpenQA, or for describing bug reproducers, etc.
+
+## Development
+
+Currently, the development has finished **Phase 0**.
+
+Which means that the script is able to understand:
+
+* mouse events (click, double click, drag, vertical scroll)
+* mouse button (left, middle, right)
+* keyboard events (press and release)
+* various keys (modifiers, special keys, charkeys, etc.)
+* record a list of that events
+* produce a chronological *json* file.
+
 
-Automated OpenQA framework
\ No newline at end of file