mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-05 05:15:48 +00:00
Fix readme syntax
This commit is contained in:
12
README.md
12
README.md
@@ -1,4 +1,4 @@
|
||||
#ripple-lib
|
||||
# ripple-lib
|
||||
|
||||
A JavaScript API for interacting with Ripple in Node.js
|
||||
|
||||
@@ -6,14 +6,14 @@ A JavaScript API for interacting with Ripple in Node.js
|
||||
|
||||
[](https://www.npmjs.org/package/ripple-lib)
|
||||
|
||||
###Features
|
||||
### Features
|
||||
|
||||
+ Connect to a rippled server in Node.js
|
||||
+ Issue [rippled API](https://ripple.com/build/rippled-apis/) requests
|
||||
+ Listen to events on the Ripple network (transaction, ledger, etc.)
|
||||
+ Sign and submit transactions to the Ripple network
|
||||
|
||||
##Getting Started
|
||||
## Getting Started
|
||||
|
||||
Install `ripple-lib` using npm:
|
||||
```
|
||||
@@ -22,16 +22,16 @@ Install `ripple-lib` using npm:
|
||||
|
||||
Then see the [documentation](https://github.com/ripple/ripple-lib/blob/develop/docs/index.md) and [code samples](https://github.com/ripple/ripple-lib/tree/develop/docs/samples)
|
||||
|
||||
##Running tests
|
||||
## Running tests
|
||||
|
||||
1. Clone the repository
|
||||
2. `cd` into the repository and install dependencies with `npm install`
|
||||
3. `npm test` or `npm test --coverage` (`istanbul` will create coverage reports in coverage/lcov-report/`)
|
||||
|
||||
##Generating Documentation
|
||||
## Generating Documentation
|
||||
|
||||
The continuous integration tests require that the documentation stays up-to-date. If you make changes to the JSON schemas, fixtures, or documentation sources, you must update the documentation by running `npm run docgen`.
|
||||
|
||||
##More Information
|
||||
## More Information
|
||||
|
||||
+ [Ripple Dev Portal](https://ripple.com/build/)
|
||||
|
||||
Reference in New Issue
Block a user