Initial Project Setup (#2)

* 🔧 Add initial package.json

* 🔧 Add eslint config

* 🔧 Add assets target dir to gitignore

* 🔧 Add webpack config

* Add a contributing guide

* Add the wrapper application

* Add autogenerated docs

* Add travis config

* Add changelog

1 files changed, 42 insertions, 0 deletions

diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..2d79f30
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,42 @@
+<a name="Sumo"></a>
+
+## Sumo
+**Kind**: global class  
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| [element] | <code>HTMLElement</code> | <code></code> | the element in which to render. Required, will throw if not provided |
+| [fps] | <code>Number</code> | <code>60</code> | the fps target to maintain |
+| [verticalResolution] | <code>Number</code> | <code>224</code> | how many pixels to render in the vertical axis (gets scaled if the canvas is larger) |
+| [aspectRatio] | <code>Array.&lt;Number&gt;</code> | <code>[2.76, 1]</code> | the aspect ratio experssed as an array of two numbers, where aspect ratio x:y is [x, y] (eg. [16, 9]) |
+
+
+* [Sumo](#Sumo)
+    * [new Sumo(config)](#new_Sumo_new)
+    * [.startLoop()](#Sumo+startLoop)
+    * [.pauseLoop()](#Sumo+pauseLoop)
+
+<a name="new_Sumo_new"></a>
+
+### new Sumo(config)
+Sumo - main entry point. Attached to window->load
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| config | <code>object</code> | the configuration to extend the object |
+
+<a name="Sumo+startLoop"></a>
+
+### sumo.startLoop()
+Starts the main loop. Resets the FPS (if you change it it won't go
+live until after you stop and start the loop)
+
+**Kind**: instance method of [<code>Sumo</code>](#Sumo)  
+<a name="Sumo+pauseLoop"></a>
+
+### sumo.pauseLoop()
+Pauses the loop
+
+**Kind**: instance method of [<code>Sumo</code>](#Sumo)