Skip to content

Fix README markdown headline formatting #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix README markdown headline formatting #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Information about QuickFIX can be found at http://quickfixengine.org/. FIX is a

NOTE: If your application requires SSL support, use the QuickFIX fork here: https://github.com/karopawil/quickfix.git

###Installing######
## Installing ##

1. Download quickfix tar here: http://www.quickfixengine.org/
2. Check required dependencies: http://www.quickfixengine.org/quickfix/doc/html/dependencies.html
Expand All @@ -16,12 +16,12 @@ NOTE: If your application requires SSL support, use the QuickFIX fork here: http
4. After installing copy "config.h" from the install directory to your include directory (usually /usr/local/include/quickfix)
5. Include this module in your package.json file.

###Features######
## Features ##

This module currently supports creating an Acceptor, an Initiator, and retrieving individual Sessions.
Examples can be found in the examples directory of this project.

####Configuration######
## Configuration ##

Sessions can be configured through a properties file or directly with a String (which can be built from a JSON variable). For example, if your properties file has the following:
```
Expand Down Expand Up @@ -106,7 +106,7 @@ var fixAcceptor = new quickfix.acceptor({
});
```

####Logon Handling#######
## Logon Handling ##

You can create a custom logon handler in node-quickfix by creating a logon provider and then constructing your acceptor or initiator with it. You can also pass credentials to the constructor that will be used to populate field 553 and 554 of your logon messages.

Expand Down Expand Up @@ -138,7 +138,8 @@ var fixClient = new quickfix.initiator({
});
```

####Message format######
## Message format ##

```
message = {
header: {
Expand All @@ -159,7 +160,8 @@ message = {
}
```

####Acceptor API######
## Acceptor API ##

`start(callback) //start acceptor`

`send(msg, callback) //send json messages`
Expand All @@ -184,7 +186,8 @@ fromAdmin: message, sessionID
fromApp: message, sessionID
```

####Initiator API######
## Initiator API ##

`start(callback) //start acceptor`

`send(msg, callback) //send json messages`
Expand All @@ -199,8 +202,8 @@ fromApp: message, sessionID

`isLoggedOn() //is initiator is currently connected to a session`

## Session API ##

####Session API######
`disconnect(callback) //disconnect a session`

`getSessionID() //get session id for a session`
Expand Down