Skip to content

Commit

Permalink
Fix formatting of README
Browse files Browse the repository at this point in the history
  • Loading branch information
tlrobinson committed Jan 21, 2014
1 parent 89650ac commit 5ca6488
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ Usage

CGMiner command return a Promises/A compatible promise (specifically a [Q](https://github.com/kriskowal/q) promise):

var client = new CGMinerClient(HOST, PORT);
client.COMMAND(ARG1, ARG2).then(function(results) {
console.log(results);
}, function(err) {
// error handler
});
var client = new CGMinerClient(HOST, PORT);
client.COMMAND(ARG1, ARG2).then(function(results) {
console.log(results);
}, function(err) {
// error handler
});

COMMAND corresponds to one of the commands detailed in [CGMiner's API documentation](https://github.com/ckolivas/cgminer/blob/master/API-README).

TODO
----

* Some commands return the raw JSON response object while other return a customized object (`devs`, etc).
* Documentation.
* Documentation.

0 comments on commit 5ca6488

Please sign in to comment.