Merge pull request #45 from freedomofpress/more-informative-readme

Update README with additional context

README.md

@@ -1,22 +1,25 @@
-## Python Client for SecureDrop
+## Python SDK for SecureDrop
+
+This SDK provides a convenient Python interface to the [SecureDrop Journalist Interface API](https://docs.securedrop.org/en/latest/development/journalist_api.html). The development of the SDK was primarily motivated by the creation of the [SecureDrop Workstation](https://github.com/freedomofpress/securedrop-workstation) based on Qubes OS.
+
+The SDK is currently used by the [SecureDrop Client](https://github.com/freedomofpress/securedrop-client) that is a component of the SecureDrop Workstation. When used in Qubes OS, the SDK uses the [securedrop-proxy](https://github.com/freedomofpress/securedrop-proxy) service, as the VM which runs the client does not have network access by design.
+
+**IMPORTANT:** This project is still under active development. We do not recommend using it in any production context.
 
 ### Development
 
 This project uses [pipenv](https://docs.pipenv.org) to manage all dependencies.
-This is a Python3 project.
+This is a Python 3 project.
 
 We are using [mypy](http://mypy-lang.org) for type annotation checks.
 
-We cover all the API calls of SecureDrop.
-
-Note: The `get_source` will get an update to take a Source object as an input.
-
-We will also add a bunch of more tests.
+We cover all the API calls supported by the SecureDrop Journalist Interface API.
 
+Additional tests will be added in future.
 
 ### Testing
 
-To test the code, you will need to run the SecureDrop `make dev` command in the same system. The test suite for
+To test the code, you will need to run the SecureDrop `make dev` command on the same system. The test suite for
 this project will test against that development container.
 
 ### License: GPLv3+