aboutsummaryrefslogtreecommitdiffstats
path: root/libs/openpgp-api-lib/README.md
diff options
context:
space:
mode:
authorSam Whited <sam@samwhited.com>2014-10-28 12:16:35 -0400
committerSam Whited <sam@samwhited.com>2014-10-28 12:16:35 -0400
commite3f4742ed81264b1bd40211ac7056909a8ce25ca (patch)
tree15796ee0711518467fe2d975f8b4d9a860a17bac /libs/openpgp-api-lib/README.md
parent4a1bae3a69a76cae0341b821e3b880e5b8b8f5a3 (diff)
parent0be263d5d3effd2df5f976fa4a127017268749cc (diff)
Subtree merged in openpgp api lib
Diffstat (limited to 'libs/openpgp-api-lib/README.md')
m---------libs/openpgp-api-lib6
-rw-r--r--libs/openpgp-api-lib/README.md21
2 files changed, 21 insertions, 6 deletions
diff --git a/libs/openpgp-api-lib b/libs/openpgp-api-lib
deleted file mode 160000
-Subproject 0be263d5d3effd2df5f976fa4a127017268749c
diff --git a/libs/openpgp-api-lib/README.md b/libs/openpgp-api-lib/README.md
new file mode 100644
index 00000000..aefc9ed3
--- /dev/null
+++ b/libs/openpgp-api-lib/README.md
@@ -0,0 +1,21 @@
+# OpenPGP API library
+
+The OpenPGP API provides methods to execute OpenPGP operations, such as sign, encrypt, decrypt, verify, and more without user interaction from background threads. This is done by connecting your client application to a remote service provided by [OpenKeychain](http://www.openkeychain.org) or other OpenPGP providers.
+
+For usage instructions, please consult our Wiki page about the [OpenPGP API](https://github.com/open-keychain/open-keychain/wiki/OpenPGP-API).
+
+License
+=======
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+