updated properties and more

Author: gitbrent

README.md

@@ -4,11 +4,11 @@
 
 Checkbox replacement using stylish bootstrap-4 switch button.
 
-Lightweight, pure JavaScript, no dependencies.
+Lightweight, no dependencies, easy webpack integration.
 
 ## Installation
 ```sh
-npm i bootstrap-switch-button-react --save
+npm i bootstrap-switch-button-react --save-dev
 ```
 
 ## Demo
@@ -18,7 +18,7 @@ import BootstrapSwitchButton from 'bootstrap-switch-button-react'
 <BootstrapSwitchButton
     checked={false}
     onlabel='Admin User'
-    offlabel='Normal User'
+    offlabel='Regular User'
     onChange={(checked: boolean) => {
         this.setState({ isUserAdmin: checked })
     }}
@@ -27,25 +27,31 @@ import BootstrapSwitchButton from 'bootstrap-switch-button-react'
 
 ![Demo](https://github.com/gitbrent/bootstrap-switch-button-react/blob/master/img/demo.gif?raw=true)
 
-## Options
-
-Name      |Type       |Default    |Description                 |
-----------|-----------|----------|----------------------------|
-`on`      |string/html|"On"      |Text of the on toggle
-`off`     |string/html|"Off"     |Text of the off toggle
-`size`    |string     |"normal"  |Size of the toggle. Possible values are: `large`, `normal`, `small`, `mini`.
-`onstyle` |string     |"primary" |Style of the on toggle. Possible values are: `primary`,`secondary`,`success`,`danger`,`warning`,`info`,`light`,`dark`
-`offstyle`|string     |"light"   |Style of the off toggle. Possible values are: `primary`,`secondary`,`success`,`danger`,`warning`,`info`,`light`,`dark`
-`style`   |string     |           |Appends the value to the class attribute of the toggle. This can be used to apply custom styles. Refer to Custom Styles for reference.
-`width`   |integer    |*null*     |Sets the width of the toggle. if set to *null*, width will be auto-calculated.
-`height`  |integer    |*null*     |Sets the height of the toggle. if set to *null*, height will be auto-calculated.
-
-## Methods
-
-Method     |Description
------------|------------------------------------------
-on         |Sets the toggle to 'On' state
-off        |Sets the toggle to 'Off' state
-toggle     |Toggles the state of the toggle on/off
-enable     |Enables the toggle
-disable    |Disables the toggle
+## Properties
+
+Name       |Type        |Default   |Description                 |
+-----------|------------|----------|----------------------------|
+`onlabel`  |string/html |"On"      |Text of the on switch-button
+`offlabel` |string/html |"Off"     |Text of the off switch-button
+`size`     |string      |          |Size of the switch-button. Possible values are: `xs`, `sm`, `lg` (no size specified means normal size).
+`onstyle`  |string      |"primary" |Style of the on switch-button. Possible values are: `primary`,`secondary`,`success`,`danger`,`warning`,`info`,`light`,`dark`
+`offstyle` |string      |"light"   |Style of the off switch-button. Possible values are: `primary`,`secondary`,`success`,`danger`,`warning`,`info`,`light`,`dark`
+`style`    |string      |          |Appends the value to the class attribute of the switch-button. This can be used to apply custom styles. Refer to Custom Styles for reference.
+`width`    |integer     |     |Sets the width of the switch-button. if set to *null*, width will be auto-calculated.
+`height`   |integer     |     |Sets the height of the switch-button. if set to *null*, height will be auto-calculated.
+
+## Example
+
+```typescript
+<BootstrapSwitchButton
+    checked={false}
+    onlabel='Admin User'
+	onstyle='danger'
+    offlabel='Regular User'
+	offstyle='success'
+	style='w-100 mx-3'
+    onChange={(checked: boolean) => {
+        this.setState({ isUserAdmin: checked })
+    }}
+/>
+```