[nongnu] elpa/textile-mode e285f64568 03/19: Update README.md

[ELPA Syncer]

branch: elpa/textile-mode
commit e285f645689417c00c8688e43dc380c148ef9a23
Author: Julien Barnier <julien@nozav.org>
Commit: Julien Barnier <julien@nozav.org>

    Update README.md
---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index c539998e6f..399e5a1cea 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,32 @@
 # textile-mode
 An emacs major mode for Textile markup language editing.
+
+## What is textile ?
+
+Textile is a markup language created by the author of TextPattern. It is used 
by some Content Management System, wikis, and there are libraries to convert 
Textile into HTML for Ruby, Python or PHP.
+
+More information on the markup can be found here :
+
+http://www.textism.com/tools/textile/
+http://hobix.com/textile/
+
+
+## Manual installation
+
+Installation of Textile-mode is really nothing original. Put the file in a 
directory into your load-path, and then add the following into your .emacs :
+
+```
+(require 'textile-mode)
+```
+
+Then you can toggle manualy the major mode with M-x textile-mode or you can 
associate it with a file extension with :
+
+```
+(add-to-list 'auto-mode-alist '("\\.textile\\'" . textile-mode))
+```
+
+## Bugs - Troubleshooting
+
+If the syntax highlighting doesn't seem to be synchronized with your text, you 
can refresh it manually on a paragraph with `M-g` `M-g`, or globally by turning 
font-locking off and on.
+
+There are some known limitations in the syntax highlighting : see the source 
code introduction for details.