Issue #3389710: Convert README.txt to REDME.md

README.md

-This very basic documentation for during development.
-Better docs will be generated closer to a full release.
+# Better Formats
 
+Better formats adds more flexibility to Drupal's core input format system.
+This module allows the administrator to restrict the content creators to
+create content of text field in a desired format. It enables few checkboxes,
+which can be checked/unchecked to limit the allowed text formats. It also gives
+an option to reorder the default order of text formats.
+(The one which is on top is used as default).
 
-The only items currently implemented in the D8 version of Better Formats are:
+For a full description of the module, visit the
+[project page](https://www.drupal.org/project/better_formats).
+
+Submit bug reports and feature suggestions, or track changes in the
+[issue queue](https://www.drupal.org/project/issues/better_formats).
+
+
+## Table of contents
+
+ - Requirements
+ - Installation
+ - Configuration
+ - Usage
+ - Maintainers
+
+
+## Requirements
+
+No special requirements.
+
+
+## Installation
+
+Install as you would normally install a contributed Drupal module. For further
+information, see
+[Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).
+
+
+## Configuration
+
+The module has no menu or modifiable settings. There is no configuration. By default
+it will be enabled in the field which have field type as text.
+
+
+## Usage
+
+### Steps to use
+
+1. Create a field on one of your entities with one of the following types:
+  - Text
+  - Long Text
+  - Long text with summary
+2. You will now see a 'Text format' section. Set the values as per your need.
+3. Save the field. The default format will now be used on all new content forms for that field .
+4. Click on 'edit' to edit the field you just saved.
+
+### Features
 
 1. Display options: When BF is enabled you will have permissions at
    admin/people/permissions to control per role display of:
@@ -22,7 +73,7 @@ The only items currently implemented in the D8 version of Better Formats are:
 
    1. At admin/config/content/formats/settings enable "Use field default"
       option.
-   2. Create a field on one of your entities with one of the following types: 
+   2. Create a field on one of your entities with one of the following types:
       Text, Long Text, Long text with summary.
    3. Save the field.
    4. Now go back and edit the field you just saved. This is required because of
@@ -35,3 +86,16 @@ The only items currently implemented in the D8 version of Better Formats are:
 3. Allowed format selection for each text field.
 
 4. Ordering of formats in Formats select box for each text field.
+
+### If you want to disable the field
+
+1. Go to _/admin/config/content/formats/settings_ .
+2. Enable the **Use field default** option.
+
+
+## Maintainers
+
+- Alan Doucette - [dragonwize](https://www.drupal.org/u/dragonwize)
+- Joseph Olstad - [joseph.olstad](https://www.drupal.org/u/josepholstad)
+- Julian Pustkuchen - [Anybody](https://www.drupal.org/u/anybody)
+- Martin Anderson-Clutz - [mandclu](https://www.drupal.org/u/mandclu)