![flok: The eventful application framework](https://raw.githubusercontent.com/sotownsend/flok/master/logo.png)

[![Gem Version](https://badge.fury.io/rb/iarrogant.svg)](http://badge.fury.io/rb/flok)
[![Build Status](https://travis-ci.org/sotownsend/flok.svg)](https://travis-ci.org/sotownsend/flok)
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/sotownsend/flok/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/sotownsend/flok/blob/master/LICENSE)

# What is this?

A work in progress

# Supported platforms
 * iOS 8 (iPhone)
 * 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)
 * [Testing](./docs/testing.md)

## Requirements

- Mac OS X 10.9+ (Untested)
- 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

Run `sudo gem install flok`

---

## FAQ

### When should I use flok?

Todo

### What's Fittr?

Fittr is a SaaS company that focuses on providing personalized workouts and health information to individuals and corporations through phenomenal interfaces and algorithmic data-collection and processing.

* * *

### Creator

- [Seo Townsend](http://github.com/sotownsend) ([@seotownsend](https://twitter.com/seotownsend))

## License

flok is released under the MIT license. See LICENSE for details.