Browse Source

updated readme

dmuratshin 10 years ago
parent
commit
a1869be5d4
1 changed files with 19 additions and 1 deletions
  1. 19 1
      README.md

+ 19 - 1
README.md

@@ -1,2 +1,20 @@
 # oxygine-flow
 # oxygine-flow
-Dialods/Senes/Transitions library for Oxygine
+oxygine-flow is an expansion for oxygine which provides a neat system for dialogue/scene organization based on an asynchronous model of events.
+
+manual:
+https://bitbucket.org/oxygine/oxygine-framework/wiki/oxygine-flow
+
+
+##Example
+see https://github.com/oxygine/oxygine-flow/blob/master/examples/HelloFlow/src/example.cpp
+
+```cpp
+flow::show(new MyScene, [](Event * event){
+        log::messageln("scene closed");
+
+        //show dialog
+        flow::show(new MyDialog, [ = ](Event*){
+                log::messageln("dialog closed");
+            });
+    });
+```