README.md in flok-0.0.1 vs README.md in flok-0.0.2
- old
+ new
@@ -1,14 +1,32 @@
-
+
[](http://badge.fury.io/rb/flok)
[](https://travis-ci.org/sotownsend/flok)
[](https://bitdeli.com/free "Bitdeli Badge")
[](https://github.com/sotownsend/flok/blob/master/LICENSE)
# What is this?
A work in progress
+
+# Flok Modules
+A concept borrowed from [Rails engines](http://guides.rubyonrails.org/engines.html), Flok modules both serve as your project files, all library modules, and gemified instances. That is, a project you create is automatically modular and can be imported in another flok module/project.
+
+# Compilation
+Flok does not rely on ruby for the final produced `application.js` file. The output file is pure javascript and written in javascript (not transcoded). Ruby only serves as a compilation assistant.
+
+# Task
+The task is the base unit in flok, similar to a rack module except that rack is a stack and flok is a party. Based on concepts borrowed from XNU®, FreeBSD®, and GNU HURD®; tasks are combined in flok to produce behavior by many tasks inter-cooperating. Efficiency has been provided through virtualizing the task communication so that no message passing takes place inside flok and all modules are combined into an efficient monolithic module.
+
+### Task Facilities
+Tasks are able to
+ - send and receive events from a global or internal source.
+ - set interval and timeout timers.
+ - store temporary data in it's own heap '$__'
+
+### Default modules
+This flok project contains the 'micro-task-kernel', the 'ui', and the 'operations' modules.
## Requirements
- Mac OS X 10.9+ (Untested)
- Ruby 2.1 or Higher