aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Edgecumbe <git@esotericnonsense.com>2019-10-27 03:55:48 +0100
committerDaniel Edgecumbe <git@esotericnonsense.com>2019-10-27 03:55:48 +0100
commit8f07be0d9140679966bbc0b0d6827971880086ba (patch)
tree3dbef9f50e833b47af7479d65710fec0a25c2fc5
parente301b80be2cb842537a392ace4054a7b10fa388e (diff)
Add comment on use of pfx cert to docs
-rw-r--r--src/lib.rs11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 9eda785..688572f 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -21,6 +21,17 @@
//! Coming soon: automatic keep-alive.
//!
//! ## Example
+//! 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.
+//!
//! ```
//! use botfair::generated_types::{MarketBook, MarketCatalogue};
//! use botfair::generated_types::{MarketFilter, MarketId};