README.md in flok-0.0.12 vs README.md in flok-0.0.14
- old
+ new
@@ -14,29 +14,42 @@
* HTML5
## Docs
* [Project Layout](./docs/project_layout.md)
- * [Platform Drivers](./docs/platform_drivers.md)
- * [Driver Interface](./docs/driver_interface.md)
* [Architecture](./docs/architecture.md)
* [Compilation](./docs/compilation.md)
- * [System Interface](./docs/interface.md)
+ * [Messaging](./docs/messaging.md)
+ * [Drivers](./docs/drivers.md)
+ * [Kernel API](./docs/kernel_api.md)
+ * [Rake Tasks](./docs/rakefile.md)
+ * [Interactive (Mostly debugging)](./docs/interactive.md)
* [Testing](./docs/testing.md)
+ * [Modules](./docs/modules.md)
+ * [Event (event.js)](./mod/event.md) - Send and receive events to arbitrary objects
+ * [User Interface (ui.js)](./mod/ui.md) - Support displaying views and view hierarchies
+ * [Net (net.js)](./mod/net.md) - Support asynchronous network connections
+ * [Timer (timer.js)](./mod/timer.md) - A tick to keep the system up-to-date and support timeout callbacks
+ * [Persistance (store.js)](./mod/store.md) - A way to store data in a key value system as well as larger blobs
+ * [Transitions (transition.js)](./mod/transition.md) - Works with `ui` to provide interception of segues
## Requirements
-- Mac OS X 10.9+ (Untested)
+- Modern **nix** (FreeBSD, Mac, or Linux)
- Ruby 2.1 or Higher
## Communication
- If you **found a bug**, open an issue.
- If you **have a feature request**, open an issue.
- If you **want to contribute**, submit a pull request.
## Installation
+RVM users:
+Run `gem install flok`
+
+System ruby installation?
Run `sudo gem install flok`
---
## FAQ