Generate markdown README

1 files changed, 55 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b91adf8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+
+# Table of Contents
+
+1.  [Introduction](#org1251c3e)
+2.  [Demo](#org4f4c28d)
+3.  [Installation](#org7a6a768)
+4.  [Contributing](#orge5d1fb8)
+
+
+
+<a id="org1251c3e"></a>
+
+# Introduction
+
+`git-email` integrates git and email with Emacs, it offers three main
+functions for sending and receiving email with git.
+
+-   `git-email-send-email` will send the marked files as patches using your
+    mail client of choice.  This means that you have to first run
+    `git format-patch` to generate the patches.
+
+-   `git-email-format-patch` will ask you for a revision and generate
+    patches for all the changes that occured between the revision and the
+    current HEAD.  It will then prepare the patches as email messages in
+    the same way as `git-email-send-email`.
+
+-   `git-email-apply-patch` will ask you for a project to cd into and then
+    apply the patch in the current buffer using `git am`.  You can also
+    specify your own function to extract the patch from the buffer by
+    changing the `git-email-apply-patch-function` variable.
+
+You can see all the customizable variables running M-x `customize-group`
+RET `git-email` RET.
+
+
+<a id="org4f4c28d"></a>
+
+# Demo
+
+![img](demo.gif)
+
+
+<a id="org7a6a768"></a>
+
+# Installation
+
+You can install it by cloning this repo and adding `git-email.el` to your `load-path`.
+
+
+<a id="orge5d1fb8"></a>
+
+# Contributing
+
+You can send patches to the [git-email-devel](https://lists.sr.ht/~yoctocell/git-email-devel) mailing list.
+