diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..eb56ff7 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# git-email + +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 +'git format-patch`. It inserts the relevant headers and the diff into the +message buffer. + +`git-email-format-patch` is a wrapper for 'git format-patch' and it +automatically composes an email for each generated patch, in the same way +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: + +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. |