aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 21 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000000..9edd5a2121
--- /dev/null
+++ b/README
@@ -0,0 +1,21 @@
+AuthServiceProxy is an improved version of python-jsonrpc.
+
+It includes the following generic improvements:
+
+- HTTP connections persist for the life of the AuthServiceProxy object
+- sends protocol 'version', per JSON-RPC 1.1
+- sends proper, incrementing 'id'
+- uses standard Python json lib
+
+It also includes the following bitcoin-specific details:
+
+- sends Basic HTTP authentication headers
+- parses all JSON numbers that look like floats as Decimal
+
+Installation:
+
+- change the first line of setup.py to point to the directory of your installation of python 2.*
+- run setup.py
+
+Note: This will only install bitcoinrpc. If you also want to install jsonrpc to preserve
+backwards compatibility, you have to replace 'bitcoinrpc' with 'jsonrpc' in setup.py and run it again.