aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDominik Schürmann <dominik@dominikschuermann.de>2013-09-10 23:23:03 +0200
committerDominik Schürmann <dominik@dominikschuermann.de>2013-09-10 23:23:03 +0200
commit0a279eaae174bf9558a3bda0e61d99563983cca2 (patch)
tree6fd3c2bcf626f92368321bd9557496d90c5ff640 /README.md
parent9a5707c41526f5fbcb45f72ec50c6f2efdd83056 (diff)
downloadopen-keychain-0a279eaae174bf9558a3bda0e61d99563983cca2.tar.gz
open-keychain-0a279eaae174bf9558a3bda0e61d99563983cca2.tar.bz2
open-keychain-0a279eaae174bf9558a3bda0e61d99563983cca2.zip
Update api in readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 10 insertions, 11 deletions
diff --git a/README.md b/README.md
index e3424ce52..c3a88dc43 100644
--- a/README.md
+++ b/README.md
@@ -82,10 +82,9 @@ API Demo: https://play.google.com/stor/apps/details?id=org.sufficientlysecure.ke
Design
------
-As discussed previously I now present my new Crypto API that I propose
-for integration into k9mail. All apps wanting to use this generic API
+All apps wanting to use this generic API
just need to include the AIDL files and connect to the service. Other
-crypto apps can implement a service based on this AIDL definition.
+OpenPGP apps can implement a service based on this AIDL definition.
The API is designed to be as easy as possible to use by apps like
k9mail. The service definition defines
@@ -103,13 +102,13 @@ Please try the Demo app out to see how it works [4].
Integration
-----------
-The API is defined as AIDL interfaces in org.openintents.crypto packge
+The API is defined as AIDL interfaces in org.openintents.openpgp packge
[2]. All files from [2] needs to be included in the project.
-Using the CryptoServiceConnection.java [3] you can choose to which
-crypto provider you want to connect (other pgp apps can implement the
+Using the OpenPgpServiceConnection.java [3] you can choose to which
+OpenPGP provider you want to connect (other pgp apps can implement the
interfaces). They can be queried as shown in the demo app (see [3] how
-to query). If other crypto apps implement the service, no additional
+to query). If other OpenPGP apps implement the service, no additional
code is required in k9mail per provider. See [3] for a complete example
for integration.
@@ -119,13 +118,13 @@ ToDos
- signature results needs improvements (should also contain email address)
- Integration in k9mail
-[1] https://github.com/dschuermann/openpgp-keychain/blob/master/OpenPGP-Keychain-API-Demo/src/org/openintents/crypto/ICryptoService.aidl
+[1] https://github.com/dschuermann/openpgp-keychain/blob/master/OpenPGP-Keychain-API-Demo/src/org/openintents/openpgp/IOpenPgpService.aidl
-[2] https://github.com/dschuermann/openpgp-keychain/tree/master/OpenPGP-Keychain-API-Demo/src/org/openintents/crypto
+[2] https://github.com/dschuermann/openpgp-keychain/tree/master/OpenPGP-Keychain-API-Demo/src/org/openintents/openpgp
-[3] https://github.com/dschuermann/openpgp-keychain/blob/master/OpenPGP-Keychain-API-Demo/src/org/openintents/crypto/CryptoServiceConnection.java
+[3] https://github.com/dschuermann/openpgp-keychain/blob/master/OpenPGP-Keychain-API-Demo/src/org/openintents/openpgp/OpenPgpServiceConnection.java
-[3] https://github.com/dschuermann/openpgp-keychain/blob/master/OpenPGP-Keychain-API-Demo/src/org/sufficientlysecure/keychain/demo/CryptoProviderDemoActivity.java
+[3] https://github.com/dschuermann/openpgp-keychain/blob/master/OpenPGP-Keychain-API-Demo/src/org/sufficientlysecure/keychain/demo/OpenPgpProviderActivity.java
[4] https://play.google.com/stor/apps/details?id=org.sufficientlysecure.keychain.demo