aboutsummaryrefslogtreecommitdiff
path: root/libgitmail/README
diff options
context:
space:
mode:
authorKatharina Fey <kookie@spacekookie.de>2020-01-09 21:30:25 +0000
committerKatharina Fey <kookie@spacekookie.de>2020-01-10 01:05:26 +0000
commitfdb464b380dcda0f9afeee080ebe988e3934e02b (patch)
treeb46ebdea03117f2f6f82e65a2542ae4b6e8f2e5d /libgitmail/README
parentad1ad814ab2c4c89a3e8b6538f93c6c2b455efb3 (diff)
Refactoring libgitmail core to work on complete emails, with tests
Diffstat (limited to 'libgitmail/README')
-rw-r--r--libgitmail/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/libgitmail/README b/libgitmail/README
new file mode 100644
index 0000000..0d3ba07
--- /dev/null
+++ b/libgitmail/README
@@ -0,0 +1,18 @@
+libgitmail
+==========
+
+This library provides an abstraction over git sent email patches. It
+parses incoming mail and provides a strongly typed interface for
+interacting with patches, patch trees, as well as building patch sets
+from a tree thread with many revisions.
+
+It then compiles a new thread of mail that can be piped directly into
+git am - by some user interface.
+
+
+License
+-------
+
+This library is part of dev-suite and as such licensed under the GNU
+General Public License 3.0 or, (at your choosing), any later version.
+See the LICENSE.md in the parent repository for more details.