Merge pull request #7 from surveycto/develop

Develop

Author: cking0987

README.md

@@ -1,14 +1,44 @@
 # Baseline integer field
 
-![](extras/baseline-integer.jpg)
+![Screenshot](extras/baseline-integer.jpg)
 
 ## Description
 
-A simple replacement for the default integer field, plus a few improvements (see below). You can either download and use this as-is, or you can use it as a starting template when creating your own field plug-in for a integer field.
+A simple replacement for the default *integer* field, plus a few improvements (see below). You can either download and use this as-is, or you can use it as a starting template when creating your own field plug-in for a *integer* field.
 
 [![Download now](extras/download-button.png)](https://github.com/surveycto/baseline-integer/raw/master/baseline-integer.fieldplugin.zip)
 
-## Default SurveyCTO feature support
+### Features
+
+In addition to supporting the default SurveyCTO features listed below, this field plug-in offers the following expanded functionality:
+
+1. **Support for RTL languages**  
+    If your *label* or *hint* is in a language that uses a right-to-left alphabet (like Arabic), it will be right-justified.
+1. **Support for HTML in field references**  
+    If you reference another field's value in either the field *label* or field *hint*, and that referenced value contains HTML, the HTML will be correctly rendered.
+
+### Data format
+
+This field plug-in requires the `integer` field type.
+
+## How to use
+
+### Getting started
+
+**To use this plug-in as-is**, just download the [baseline-integer.fieldplugin.zip](https://github.com/surveycto/baseline-integer/raw/master/baseline-integer.fieldplugin.zip) file from this repo, specify this field plug-in as a custom field *appearance* in the form design (like in the [test form](https://github.com/surveycto/baseline-integer/raw/master/extras/test-form/test-form-package.zip)), and attach it to your form. For more details about using field plug-ins, please read the [user documentation](https://docs.surveycto.com/02-designing-forms/03-advanced-topics/06.using-field-plug-ins.html).
+
+**To create your own** field plug-in using this as a template, follow these steps:
+
+1. Fork this repo
+1. Make changes to the files in the `source` directory.  
+    * **Note:** be sure to update the `manifest.json` file as well.
+1. Zip the updated contents of the `source` directory.
+1. Rename the .zip file to *yourpluginname*.fieldplugin.zip (replace *yourpluginname* with the name you want to use for your plug-in).
+1. You may then attach your new .fieldplugin.zip file to your form as normal.
+
+For more information about developing your own field plug-ins, please read the [developer documentation](https://github.com/surveycto/Field-plug-in-resources).
+
+### Default SurveyCTO feature support
 
 | Feature / Property | Support |
 | --- | --- |
@@ -22,37 +52,15 @@ A simple replacement for the default integer field, plus a few improvements (see
 | media:video | Yes |
 | `show-formatted` appearance | No |
 
-## Expanded feature support
-
-In addition to supporting the default SurveyCTO features listed above, this field plug-in offers the following expanded functionality:
-
-1. Support for RTL languages  
-    If your *label* or *hint* is in a language that uses a right-to-left alphabet (like Arabic), it will be right-justified.
-1. Support for HTML in field references  
-    If you reference another field's value in either the field *label* or field *hint*, and that referenced value contains HTML, the HTML will be correctly rendered.
+### Parameters
 
 **Note about the keyboard on iOS:**  
-iOS has a less-consistent way of determining which on-screen keyboard to display than Android. If you plan on using this plug-in on iOS, you should test your form on the actual iOS device that you plan on using. If the wrong keyboard appears (for example, if there is no minus button available), you may supply an optional parameter to the plug-in to set the keyboard type manually. 
+iOS has a less-consistent way of determining which on-screen keyboard to display than Android. If you plan on using this plug-in on iOS, you should test your form on the actual iOS device that you plan on using. If the wrong keyboard appears (for example, if there is no minus button available), you may supply an optional parameter to the plug-in to set the keyboard type manually.
 
 | Parameter key | Parameter value |
 | --- | --- |
 | `ios-inputmode` | Possible values: `none`, `text`, `decimal`, `numeric`, `tel`, `search`, `email`, `url`. [Click here for more information about the inputmode attibute.](https://css-tricks.com/everything-you-ever-wanted-to-know-about-inputmode)|
 
-## How to use
-
-**To use this plug-in as-is**, just download the [baseline-integer.fieldplugin.zip](https://github.com/surveycto/baseline-integer/raw/master/baseline-integer.fieldplugin.zip) file from this repo, and attach it to your form.
-
-To create your own field plug-in using this as a template, follow these steps:
-
-1. Fork this repo
-1. Make changes to the files in the `source` directory.
-
-    * **Note:** be sure to update the `manifest.json` file as well.
-
-1. Zip the updated contents of the `source` directory.
-1. Rename the .zip file to *yourpluginname*.fieldplugin.zip (replace *yourpluginname* with the name you want to use for your plug-in).
-1. You may then attach your new .fieldplugin.zip file to your form as normal.
-
 ## More resources
 
 * **Test form**