summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..c7ca265
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,31 @@
+markdown-link-style
+===================
+
+A script that lets you switch between inline and footnote link style
+in markdown documents.
+
+source
+------
+
+::
+
+ git clone git://git.ricketyspace.net/markdown-link-style.git
+
+usage
+-----
+
+::
+
+ # switch to footnote link style
+ $ mdl-style -f path/to/document.md
+
+ # switch to inline link style
+ $ mdl-style -i path/to/document.md
+
+license
+-------
+
+Under `GNU General Public License version 3 or later`__.
+
+.. _gplv3: https://www.gnu.org/licenses/gpl-3.0-standalone.html
+__ gplv3_