aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoryoctocell <public@yoctocell.xyz>2021-01-08 12:31:33 +0100
committeryoctocell <public@yoctocell.xyz>2021-01-08 12:31:33 +0100
commit8e5622bc3c7c447f9b4c8b4916d8a6f56b9dacc2 (patch)
tree69760f55320d3ec7ecb619602b1cdfdbb98e128e /README.md
parent785788a541e433f98fbb04cc4e77c84697e088d8 (diff)
Add install instructions
* README.md:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 4 insertions, 6 deletions
diff --git a/README.md b/README.md
index eb56ff7..d6d31b4 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
# git-email
-
+## Introduction
This package integrates with git and `message-mode` and offers three main functions - `git-email-send-email`, `git-email-format-patch` and `git-email-apply-patch`.
`git-email-send-email` sends an email based on a patch file generated by
@@ -13,10 +13,8 @@ as `git-email-send-email'.
`git-email-apply-patch` will apply the patch that you are currently viewing
and it will ask to for the project that the patch belongs to.
-## Contributing:
+## Installation
+You can install it by cloning this repo and adding `git-email.el` to your `load-path`.
+## Contributing:
You can contribute patches to the project via the [git-email-devel](https://lists.sr.ht/~yoctocell/git-email-devel) list, using [git send-email](https://git-send-email.io/).
-
-## TODOs
-
-- Add proper syntax highlighting to diffs in the message buffer.