Revised the documentation section of the file. Added version attribute

to the module.

1 files changed, 18 insertions, 18 deletions

diff --git a/markdown.py b/markdown.py
index 4201891..9b2d8e7 100644
--- a/markdown.py
+++ b/markdown.py
@@ -1,41 +1,34 @@
 #!/usr/bin/env python
 
-# The following constant specifies the name used in the usage
-# statement displayed for python versions lower than 2.3.  (With
-# python2.3 and higher the usage statement is generated by optparse
-# and uses the actual name of the executable called.)
-
-EXECUTABLE_NAME_FOR_USAGE = "python markdown.py"
-
-SPEED_TEST = 0
+version = "1.6b"
+version_info = (1,6,2,"rc-2")
+__revision__ = "$Rev$"
 
 """
-====================================================================
-IF YOU ARE LOOKING TO EXTEND MARKDOWN, SEE THE "FOOTNOTES" SECTION
-====================================================================
-
 Python-Markdown
 ===============
 
 Converts Markdown to HTML.  Basic usage as a module:
 
     import markdown
-    html = markdown.markdown(your_text_string)
+    md = Markdown()
+    html = markdown.convert(your_text_string)
+
+See http://www.freewisdom.org/projects/python-markdown/ for more
+information and instructions on how to extend the functionality of the
+script.  (You might want to read that before you try modifying this
+file.)
 
 Started by [Manfred Stienstra](http://www.dwerg.net/).  Continued and
 maintained  by [Yuri Takhteyev](http://www.freewisdom.org).
 
-Project website: http://www.freewisdom.org/projects/python-markdown
 Contact: yuri [at] freewisdom.org
 
 License: GPL 2 (http://www.gnu.org/copyleft/gpl.html) or BSD
 
-Version: 1.6a (October 12, 2006)
-
-
-For changelog, see the end of file
 """
 
+
 import re, sys, os, random, codecs
 
 # Set debug level: 3 none, 2 critical, 1 informative, 0 all
@@ -81,6 +74,13 @@ def removeBOM(text, encoding):
         if text.startswith(bom):
             return text.lstrip(bom)
     return text
+
+# The following constant specifies the name used in the usage
+# statement displayed for python versions lower than 2.3.  (With
+# python2.3 and higher the usage statement is generated by optparse
+# and uses the actual name of the executable called.)
+
+EXECUTABLE_NAME_FOR_USAGE = "python markdown.py"
                     
 
 # --------------- CONSTANTS YOU _SHOULD NOT_ HAVE TO CHANGE ----------