From 0666ea46470a10334178a355a3895423f9906908 Mon Sep 17 00:00:00 2001 From: Ola Bini Date: Thu, 31 Jul 2014 19:43:47 -0300 Subject: Rearrange README's and make the content make sense --- service/README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 service/README.md (limited to 'service/README.md') diff --git a/service/README.md b/service/README.md new file mode 100644 index 00000000..971b1494 --- /dev/null +++ b/service/README.md @@ -0,0 +1,37 @@ +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. + +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. -- cgit v1.2.3