summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorjoe <joe@jerkface.net>2016-04-14 12:50:25 -0400
committerjoe <joe@jerkface.net>2016-04-14 12:51:36 -0400
commit47fbb4b70ee6c74937ed4b55540b612aacc3de80 (patch)
tree3d3577a0e3706512cd2c49938e91acf72e203249 /README
parent880f16b4e52bbf96dd531c1c4b864423b057b770 (diff)
parent37d5a99e9f2303780a7cdbf4730ace6eff58a466 (diff)
Merged openpgp package into openpgp-util
Diffstat (limited to 'README')
-rw-r--r--README19
1 files changed, 19 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..ddad150
--- /dev/null
+++ b/README
@@ -0,0 +1,19 @@
1This is an OpenPGP library inspired by my work on OpenPGP libraries in
2Ruby <https://github.com/singpolyma/openpgp>,
3PHP <http://github.com/singpolyma/openpgp-php>,
4and Python <https://github.com/singpolyma/OpenPGP-Python>.
5
6It defines types to represent OpenPGP messages as a series of packets
7and then defines instances of Data.Binary for each to facilitate
8encoding/decoding.
9
10For performing cryptography, see
11<http://hackage.haskell.org/package/openpgp-crypto-api> or
12<http://hackage.haskell.org/package/openpgp-Crypto>
13
14For dealing with ASCII armor, see
15<http://hackage.haskell.org/package/openpgp-asciiarmor>
16
17It is intended that you use qualified imports with this library.
18
19> import qualified Data.OpenPGP as OpenPGP