From dac8b6c64cf6a40553ebb50f8705b6dcaaeb2497 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Sch=C3=BCrmann?= Date: Sun, 23 Aug 2015 20:40:23 +0200 Subject: Better readme --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index dba3c3e..2ce1033 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ 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. -## News +### News #### Version 8 * OpenPgpSignatureResult: @@ -13,10 +13,10 @@ The OpenPGP API provides methods to execute OpenPGP operations, such as sign, en * RESULT_TYPES have been removed * new OpenPgpDecryptionResult returned via RESULT_DECRYPTION * OpenPgpSignatureResult and OpenPgpDecryptionResult are never null, they are always returned. - + [Full changelog here…](https://github.com/open-keychain/openpgp-api/blob/master/CHANGELOG.md) -## License +### License While OpenKeychain itself is GPLv3+, the API library is licensed under Apache License v2. Thus, you are allowed to also use it in closed source applications as long as you respect the [Apache License v2](https://github.com/open-keychain/openpgp-api/blob/master/LICENSE). @@ -24,7 +24,7 @@ Thus, you are allowed to also use it in closed source applications as long as yo Add this to your build.gradle: -``` +```gradle repositories { jcenter() } @@ -34,11 +34,17 @@ dependencies { } ``` -## Full working example -A complete working example is available in the [example project](https://github.com/open-keychain/openpgp-api/blob/master/example). The [``OpenPgpApiActivity.java``](https://github.com/open-keychain/openpgp-api/blob/master/example/src/main/java/org/openintents/openpgp/example/OpenPgpApiActivity.java) contains most relevant sourcecode. +### Full example +A full working example is available in the [example project](https://github.com/open-keychain/openpgp-api/blob/master/example). The [``OpenPgpApiActivity.java``](https://github.com/open-keychain/openpgp-api/blob/master/example/src/main/java/org/openintents/openpgp/example/OpenPgpApiActivity.java) contains most relevant sourcecode. + +### API +[OpenPgpApi](https://github.com/open-keychain/openpgp-api/blob/master/openpgp-api/src/main/java/org/openintents/openpgp/util/OpenPgpApi.java) contains all possible Intents and available extras. ### Short tutorial + +**This tutorial only covers the basics, please consult the full example for a complete overview over all methods** + The API is **not** designed around ``Intents`` which are started via ``startActivityForResult``. These Intent actions typically start an activity for user interaction, so they are not suitable for background tasks. Most API design decisions are explained at [the bottom of this wiki page](https://github.com/open-keychain/open-keychain/wiki/OpenPGP-API#internal-design-decisions). We will go through the basic steps to understand how this API works, following this (greatly simplified) sequence diagram: -- cgit v1.2.3