aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDominik Schürmann <dominik@dominikschuermann.de>2014-09-02 16:11:07 +0200
committerDominik Schürmann <dominik@dominikschuermann.de>2014-09-02 16:11:07 +0200
commit3bcf7266c3944c5aad417ae339eaf4420783877d (patch)
tree8e73c54875af222c9b7290afc3dde7fc7e8587de
parent8b36d286680ee57b2181e86a3f02ba1278a81166 (diff)
Update README
Diffstat (limited to '')
-rw-r--r--README.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/README.md b/README.md
index da8361e8..ac54aa29 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,21 @@
-# OpenPGP Remote API library
+# OpenPGP API library
+
+The OpenPGP API provides methods to do common 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 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.
-For usage instructions, please consult our Wiki page about the [OpenPGP Remote API](https://github.com/open-keychain/open-keychain/wiki/OpenPGP-API). \ No newline at end of file