aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Edgecumbe <git@esotericnonsense.com>2019-10-27 03:53:00 +0100
committerDaniel Edgecumbe <git@esotericnonsense.com>2019-10-27 03:53:00 +0100
commite301b80be2cb842537a392ace4054a7b10fa388e (patch)
tree6e5d58b571f3509734f7438b9196199ead38c48e
parentdb4586ca076539227a6a249edc3b3f43e45fed98 (diff)
Comment on use of pfx cert
-rw-r--r--README.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.md b/README.md
index 1b3cd61..6b9fdb4 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# botfair
+# `botfair`
Rust bindings for the Betfair SportsAPING.
Automatic login.
@@ -13,6 +13,17 @@ Daniel Edgecumbe (esotericnonsense)
[botfair@esotericnonsense.com](mailto:botfair@esotericnonsense.com)
## Usage
+Note that `botfair` requires your certificate to be in `pfx` format.
+In order to achieve this given a key and crt file, you can use the following
+openssl command:
+
+```
+openssl pkcs12 -export -out client.pfx \
+ -inkey client.key -in client.crt
+```
+
+`botfair` assumes no password protection for the `pfx` file.
+
```
let bf_creds = BFCredentials::new(
"my_username".to_owned(),
@@ -65,7 +76,7 @@ servers and runs a python script on them to generate the Rust bindings.
## License
-For open source software, botfair is subject to the GNU AGPLv3, contained
+For open source software, `botfair` is subject to the GNU AGPLv3, contained
in the document LICENSE.AGPLv3 which should be distributed with the software.
This means that you need to licence your software under the same terms. In