Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bobboteck committed Jul 12, 2015
1 parent c126bd1 commit bc1b9e3
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,20 @@ You can see an example of result in this picture

![JoyStick in action!!!](http://bobboteck.github.io/joy/JoyStick.png "JoyStick in action!!!")

But if you want see the JoyStick in action go to this [link](http://bobboteck.github.io/joy/joy.html).

Advanced Options
----------------
All configuration parameters are optional, must be passed in JSON format, then it is sufficient to indicate only the parameters whose volede give a different configuration from the value of Default.

* **title {String} (optional) - The ID of canvas (Default value is 'joystick')**
* **width {Int} (optional) - The width of canvas, if not specified is setted at width of container object (Default value is the width of container object)**
* **height {Int} (optional) - The height of canvas, if not specified is setted at height of container object (Default value is the height of container object)**
* **internalFillColor {String} (optional) - Internal color of Stick (Default value is '#00AA00')**
* **internalLineWidth {Int} (optional) - Border width of Stick (Default value is 2)**
* **internalStrokeColor {String}(optional) - Border color of Stick (Default value is '#003300')**
* **externalLineWidth {Int} (optional) - External reference circonference width (Default value is 2)**
* **externalStrokeColor {String} (optional) - External reference circonference color (Default value is '#008000')**
* **title {String} (optional)** - The ID of canvas (Default value is 'joystick')
* **width {Int} (optional)** - The width of canvas, if not specified is setted at width of container object (Default value is the width of container object)
* **height {Int} (optional)** - The height of canvas, if not specified is setted at height of container object (Default value is the height of container object)
* **internalFillColor {String} (optional)** - Internal color of Stick (Default value is '#00AA00')
* **internalLineWidth {Int} (optional)** - Border width of Stick (Default value is 2)
* **internalStrokeColor {String}(optional)** - Border color of Stick (Default value is '#003300')
* **externalLineWidth {Int} (optional)** - External reference circonference width (Default value is 2)
* **externalStrokeColor {String} (optional)** - External reference circonference color (Default value is '#008000')

Tips & Tricks
--------------
Expand Down

0 comments on commit bc1b9e3

Please sign in to comment.