[gnome-shell-extensions/wip/fmuellner/markdown] docs: Use markdown

[Florian Müllner <fmuellner src gnome org>]

commit 724249dd2981347bbf8a9aa09b0e6273e55da0b7
Author: Florian Müllner <fmuellner gnome org>
Date:   Sat Nov 25 02:06:58 2017 +0100

    docs: Use markdown
    
    Markdown produces nicer output where supported, so use that instead
    of custom ASCII formatting.

 HACKING => HACKING.md | 12 ++++----
 README                | 81 -------------------------------------------------
 README.md             | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 90 insertions(+), 87 deletions(-)
---
diff --git a/HACKING b/HACKING.md
similarity index 76%
rename from HACKING
rename to HACKING.md
index 3bc2444..217bd50 100644
--- a/HACKING
+++ b/HACKING.md
@@ -1,4 +1,4 @@
---- Creating a New Extension ---
+## Creating a New Extension
 
 To create a new extension, add a subdirectory in extensions.
 Then create a Makefile.am like the one in example, replacing
@@ -15,12 +15,10 @@ The Gettext domain you should choose is gnome-shell-extensions,
 not gnome-shell, unless you're sure there is the string you
 need in gnome-shell.
 
---- Coding Style ---
+## Coding Style
 
-Generally, we follow GJS coding style (you can find it at
-http://git.gnome.org/browse/gjs/tree/doc/Style_Guide.txt), which
-in short is: indent 4 spaces, no tabs, space after comma, no space
-after function call.
+Generally, we follow [GJS coding style][coding-style], which in short is:
+indent 4 spaces, no tabs, space after comma, no space after function call.
 
 The Emacs mode line for this
 /* -*- mode: js2; js2-basic-offset: 4; indent-tabs-mode: nil -*- */
@@ -29,3 +27,5 @@ Imports should be at the top, in two groups, one for standard
 imports (like imports.lang or imports.dbus) and introspection,
 the other for Shell API. Within the same group, put everything
 in alphabetic order.
+
+[coding-style]: https://gitlab.gnome.org/GNOME/gjs/blob/master/doc/Style_Guide.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f9872dd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,84 @@
+# GNOME Shell Extensions
+
+GNOME Shell Extensions is a collection of extensions providing additional
+and optional functionality to GNOME Shell.
+
+Since GNOME Shell is not API stable, extensions work only against a very
+specific version of the shell, usually the same as this package (see
+"configure --version"). The extensions in this package are supported by GNOME
+and will be updated to reflect future API changes in GNOME Shell.
+
+The GNOME wiki has more information about [GNOME Shell Extensions][project-page],
+as well as some general information about [GNOME Shell][shell-page].
+
+Bugs should be reported to the GNOME [bug tracking system][bug-tracker].
+
+## Extensions
+
+ * alternate-tab
+ 
+     Lets you use classic Alt+Tab (window-based instead of app-based) in GNOME Shell.
+
+ * apps-menu
+
+     Lets you reach an application using gnome 2.x style menu on the panel.
+
+ * auto-move-windows
+
+     Lets you manage your workspaces more easily, assigning a specific workspace to
+each application as soon as it creates a window, in a manner configurable with a
+GSettings key.
+
+ * drive-menu
+ 
+     Shows a status menu for rapid unmount and power off of external storage devices
+  (i.e. pendrives)
+
+ * example
+
+     A minimal example illustrating how to write extensions.
+
+ * launch-new-instance
+
+     Changes application icons to always launch a new instance when activated.
+
+ * native-window-placement
+
+     An alternative algorithm for layouting the thumbnails in the windows overview, that
+  more closely reflects the actual positions and sizes.
+
+ * places-menu
+
+     Shows a status Indicator for navigating to Places.
+
+ * screenshot-window-sizer
+
+     Adds a shortcut for resizing the focus window to a size that is suitable for GNOME Software screenshots
+
+ * user-theme
+
+     Loads a shell theme from ~/.themes/<name>/gnome-shell.
+
+ * window-list
+
+     Adds a bottom panel with a traditional window list.
+
+ * windowsNavigator
+
+     Allow keyboard selection of windows and workspaces in overlay mode.
+
+ * workspace-indicator
+
+     Adds a simple workspace switcher to the top bar.
+
+## License
+
+GNOME Shell Extensions are distributed under the terms of the GNU General
+Public License, version 2 or later. See the [COPYING file][license] for details.
+Individual extensions may be licensed under different terms, see each source
+file for details.
+
+[project-page]: https://wiki.gnome.org/Projects/GnomeShell/Extensions
+[shell-page]: https://wiki.gnome.org/Projects/GnomeShell
+[bug-tracker]: https://gitlab.gnome.org/GNOME/gnome-shell-extensions/issues
+[license]: COPYING