Skip to content

Commit 10936d4

Browse files
authored
Update README.md
1 parent 1587815 commit 10936d4

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,14 @@ Ruby interface to Interactive Brokers' TWS API
33

44
Reimplementation of the basic functions of ib-ruby
55

6-
---
7-
**Status:** The code is under final rewiew.
8-
9-
A Gem will be released shortly.
10-
11-
---
126

7+
----
138
`ib-ruby` offers a modular access to the TWS-API-Interface of Interactive Brokers.
149

1510
`ib-api` provides a simple interface to low-level TWS API-calls.
1611

12+
----
13+
1714
In its plain vanilla usage, it just exchanges messages with the TWS. The user is responsible for any further data processing.
1815

1916

@@ -44,7 +41,18 @@ puts ib.recieved[:OrderStatus].to_human
4441
```
4542

4643

44+
## Tests
4745

46+
are invoked by
47+
48+
```
49+
bundle exec guard
50+
# or
51+
bundle exec rake spec
52+
```
53+
Integration tests on order-placements are not included. To run the test suite its thus safe to use a _real Account_.
54+
You have to edit `spec/spec.yml` and replace the `:account`-Setting with your own `AccountID`, even if you connect to a single account.
55+
4856

4957

5058
## Contributing

0 commit comments

Comments
 (0)