aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDominik Schürmann <dominik@dominikschuermann.de>2013-09-15 17:10:37 +0200
committerDominik Schürmann <dominik@dominikschuermann.de>2013-09-15 17:10:37 +0200
commita18502d8d9b80b58e07a1b923d81757e2894066f (patch)
treea3796404a99feb57aea48b8e15eb5a296ed7aaf0 /README.md
parent9c285b15d3df95d783a4318bf090732f85002141 (diff)
downloadopen-keychain-a18502d8d9b80b58e07a1b923d81757e2894066f.tar.gz
open-keychain-a18502d8d9b80b58e07a1b923d81757e2894066f.tar.bz2
open-keychain-a18502d8d9b80b58e07a1b923d81757e2894066f.zip
README
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 6 insertions, 11 deletions
diff --git a/README.md b/README.md
index f23e334c0..21a4f5f69 100644
--- a/README.md
+++ b/README.md
@@ -38,18 +38,16 @@ Android Studio is currently not supported or recommended!
# Keychain API
-## API without registering the app
-
-### Intent Actions
+## Intent API
All Intents require user interaction, e.g. to finally encrypt the user needs to press the "Encrypt" button.
To do automatic encryption/decryption/sign/verify use the OpenPGP Remote API.
-Android Intent actions provided by OpenPGP Keychain:
+#### Android Intent actions provided by OpenPGP Keychain:
* ``android.intent.action.VIEW`` connected to .gpg and .asc files: Import Key and Decrypt
* ``android.intent.action.SEND`` connected to all mime types (text/plain and every binary data like files and images): Encrypt and Decrypt
-OpenPGP Keychain specific Intent actions:
+#### OpenPGP Keychain specific Intent actions:
* ``org.sufficientlysecure.keychain.action.ENCRYPT``
* To encrypt text use extra ``text`` (type: ``String``)
@@ -68,13 +66,11 @@ OpenPGP Keychain specific Intent actions:
To do asyncronous fast encryption/decryption/sign/verify operations bind to the OpenPGP remote service.
The API Demo contains all required AIDL files and a demo activity.
-Try out the API
---------
+#### Try out the API
Keychain: https://play.google.com/stor/apps/details?id=org.sufficientlysecure.keychain
API Demo: https://play.google.com/stor/apps/details?id=org.sufficientlysecure.keychain.demo
-Design
-------
+#### Design
All apps wanting to use this generic API
just need to include the AIDL files and connect to the service. Other
OpenPGP apps can implement a service based on this AIDL definition.
@@ -93,8 +89,7 @@ operation, OpenPGP Keychain shows an activity to allow or disallow
access, while also allowing to choose the private key used for this app.
Please try the Demo app out to see how it works [4].
-Integration
------------
+#### Integration
The API is defined as AIDL interfaces in org.openintents.openpgp packge
[2]. All files from [2] needs to be included in the project.