diff --git a/deltachat-rpc-server/README.md b/deltachat-rpc-server/README.md new file mode 100644 index 000000000..f64ec1cae --- /dev/null +++ b/deltachat-rpc-server/README.md @@ -0,0 +1,31 @@ +# Delta Chat RPC server + +This program provides a [JSON-RPC 2.0](https://www.jsonrpc.org/specification) interface to DeltaChat +over standard I/O. + +## Install + +To install run: + +```sh +cargo install --path ../deltachat-rpc-server +``` + +The `deltachat-rpc-server` executable will be installed into `$HOME/.cargo/bin` that should be available +in your `PATH`. + +## Usage + +To use just run `deltachat-rpc-server` command. The accounts folder will be created in the current +working directory unless `DC_ACCOUNTS_PATH` is set: + +```sh +export DC_ACCOUNTS_PATH=$HOME/delta/ +deltachat-rpc-server +``` + +The common use case for this program is to create bindings to use Delta Chat core from programming +languages other than Rust, for example: + +1. Python: https://github.com/deltachat/deltachat-core-rust/tree/master/deltachat-rpc-client/ +2. Go: https://github.com/deltachat/deltachat-rpc-client-go/