From 7f1228e193a1745b43c47759688d73641620fc58 Mon Sep 17 00:00:00 2001
From: Tobias Diekershoff <tobias.diekershoff@gmx.net>
Date: Sat, 1 Jun 2013 09:17:25 +0200
Subject: [PATCH] markdownification of the README

---
 mathjax/README    | 31 -------------------------------
 mathjax/README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+), 31 deletions(-)
 delete mode 100644 mathjax/README
 create mode 100644 mathjax/README.md

diff --git a/mathjax/README b/mathjax/README
deleted file mode 100644
index 023e1c89..00000000
--- a/mathjax/README
+++ /dev/null
@@ -1,31 +0,0 @@
-Addon for Friendika to include MathJax (LaTeX math syntax)
-
-This addon lets your users use LaTeX to type mathematical formulas
-within their posts. MathJax takes care about the best method for the
-browser to display the formula and provides compatibility to 99%
-of the modern browsers.
-
-You can either use the MathJax CDN online, thus loading the required javascript
-libraries from the MathJax cloud, or use a local installation of MathJax.
-Please see the plugin settings in the admin panel for configuration possibles.
-If you don't set up a local MathJax instance, leave the configuration untouched
-it will fall back to the MathJax cloud as default value.
-
-If you don't use the admin panel add mathjax to the list of active addons
-
-$a->config['system']['addon'] = [..., mathjax, ...]
-
-To select the source of the included javascript libraries add a line
-
-$a->config['mathjax']['baseurl'] = 'the URL to your MathJax installation';
-
-to your .htconfig.php file. If this line is not there, the addon assumes that
-you want to use the MathJax cloud (CDN).
-
-Please note that your usage of the CDN is governed by the "MathJax CDN Terms of
-Service" see http://www.mathjax.org/download/mathjax-cdn-terms-of-service/
-
-Author:  Tobias Diekershoff
-         http://diekershoff.homeunix.net/friendika/profile/tobias
-         email: tobias.diekershoff@gmx.net
-
diff --git a/mathjax/README.md b/mathjax/README.md
new file mode 100644
index 00000000..9647a986
--- /dev/null
+++ b/mathjax/README.md
@@ -0,0 +1,43 @@
+MathJax Addon
+=============
+
+* Author: Tobias Diekershoff
+* License: [3-clause BSD](http://opensource.org/licenses/BSD-3-Clause) license
+  (see the LICENSE file in the addon directory)
+
+About
+-----
+
+This addon for friendica includes the [MathJax][1] CDN to enable rendering of
+[LaTeX][2] formulae in your friendica postings.
+
+Configuration
+-------------
+All you need to do is provide friendica with the base URL of MathJax. This can
+be either the URL of the CDN of MathJax or your own installation.
+
+In case you want to use the CDN you can try the following URL as a quick start
+
+	http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML
+
+In case you don't want or can use the admin panel of firneidca you can activate
+the addon by adding _mathjax_ to the 
+
+	$a->config['system']['addon']
+
+list in your .htconfig.php file and then providing the base URL after that
+
+	 $a->config['mathjax']['baseurl'] = 'the URL to your MathJax installation';
+
+Usage
+=====
+
+Once the addon is configured you can use LaTeX syntax in your postings to share
+formulae with your contacts. But remember that the formulae are rendered in the
+browser of the user thus your contacts need to activate this addon as well. If
+they don't they will only see the LaTeX syntax in your texts.
+
+Just enclose your equations in $$...$$ pairs like e.g. $$f_c(x)=ax+b$$.
+
+[1]: http://www.mathjax.org/
+[2]: https://en.wikipedia.org/wiki/LaTeX