Transferred help text into README.md file.
[btcspy.git] / README
1 btcspy
2
3 GPL v3
4 David Llewellyn-Jones
5 D.Llewellyn-Jones@ljmu.ac.uk
6 david@flypig.co.uk
7 http://www.flypig.co.uk
8
9
10 To use btcspy as a standalone script, open a command window in the 
11 btcspy folder (you can do this by Shift-Right-Clicking on the folder
12 and selecting "Open command window here" from the menu). Then type the
13 following
14
15 btcspy.ph
16
17 For help type
18
19 btcspy.ph --help
20
21 To use btcspy within a Python program (or in the Python interpreter)
22 you can do the following:
23
24 import btcspy
25 result = btcspy.history()
26 print (result)
27
28 Note that for this to work, the contents of the btcspy folder has to be 
29 in the currently selected directory.
30
31 For more information, please feel free to contact David
32 D.Llewellyn-Jones@ljmu.ac.uk