diff --git a/README.md b/README.md index 02dcb2f..0a598c3 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,30 @@ Org mode. It should support the features [listed here](https://help.github.com/a You can install `ox-gfm` using elpa. It's available on [melpa](http://melpa.org/#/ox-gfm): M-x package-install ox-gfm + +## Usage + +This package adds an Org mode export backend for GitHub Flavored Markdown. + +You can read more about [Org mode exporting here.](http://orgmode.org/manual/Exporting.html) + +Org mode only loads these backends by default: ascii, html, icalendar, latex and odt + +To manually enable this package you can simply require the package: + +```emacs-lisp +(require 'ox-gfm) +``` + +If you want to automatically enable exporting to Github Flavored Markdown, you +can add this snippet in your emacs config: + +```emacs-lisp +(eval-after-load "org" + '(require 'ox-gfm nil t)) +``` + +Once the package is loaded you can use it in Org mode with [the export +dispatcher](http://orgmode.org/manual/The-export-dispatcher.html#The-export-dispatcher). + +You can use the exporter with `C-c C-e` or `M-x org-export-dispatch`