diff options
| author | Bruno Wagner <bwgpro@gmail.com> | 2014-11-21 14:51:34 -0200 |
|---|---|---|
| committer | Bruno Wagner <bwgpro@gmail.com> | 2014-11-21 14:51:34 -0200 |
| commit | 197a2631ed3c7807e956706347b64e4c7effcd82 (patch) | |
| tree | afe6907487b813d7a9387bb5899b6cf35979426f /service/README.md | |
| parent | a3a828951afbb7a8233cd2a4632aba701c030b4e (diff) | |
Updated the introduction of the service README
Diffstat (limited to 'service/README.md')
| -rw-r--r-- | service/README.md | 37 |
1 files changed, 3 insertions, 34 deletions
diff --git a/service/README.md b/service/README.md index ca0de350..a1554dff 100644 --- a/service/README.md +++ b/service/README.md @@ -1,40 +1,9 @@ Pixelated User Agent Service ============================ -This is the service for the Pixelated User Agent. The primary purpose of this is to integrate well with the Pixelated Provider and provide all the capabilities necessary for the UI to work well. +This is the service for the Pixelated User Agent. The primary purpose of this is to provide an interface for the user agent to communicate with the Pixelated Provider. -The aim is to support these resources/endpoints: - -``` -GET /mails -DELETE /mails -POST /mails -PUT /mails -POST /mails/read - -GET /mail/:id -DELETE /mail/:id -POST /mail/:id/star -POST /mail/:id/unstar -POST /mail/:id/replied -POST /mail/:id/unreplied -POST /mail/:id/read -POST /mail/:id/unread -GET /mail/:id/tags -POST /mail/:id/tags - -GET /draft_reply_for/:id - -GET /contacts -GET /contact/:id - -GET /stats - -GET /tags -POST /tags -``` - -The implementation of the User Agent Service will be in Python, in order to better work together with LEAP. Another goal of the User Agent Service will be to run well on all major client platforms. Finally, there will be a lot of support for search and indexing, and also for encryption and signing. However, we want to push most of these features back to LEAP so that Bitmask can leverage them as well. +The user agent is implemented in Python, for compatibility with the LEAP libraries. Another goal of the User Agent Service will be to run well on all major client platforms. Finally, the main goals are to have strong search, encryption and signing. However, we want to push most of these features back to LEAP so that Bitmask can leverage them as well. Development environment @@ -62,7 +31,7 @@ source .virtualenv/bin/activate You will need an account in a LEAP provider. Once you have it, modify the service/pixelated.example file and move it to ~/.pixelated -You also might need to add your LEAP provider ssl certificate inside the pixelated/certificates named as your provider domain name, example: +You might need to add your LEAP provider ssl certificate inside the pixelated/certificates named as your provider domain name, for example: ``` your.leapprovider.org.crt |