docs: clarify module purpose, cleanup readme #15
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
emschwartz
force-pushed
the
es-cleanup-readme
branch
from
c996a38 to
4f119a2
Compare
sharafian
suggested changes
Aug 8, 2017
| > framework for attaching on-ledger settlement mechanisms. | ||
| > Implements a trustline ledger plugin that can be extended to settle automatically via a payment channel | ||
|
|
||
| The ILP Plugin Payment Channel Framework implements a [trustline](https://github.com/interledger/rfcs/blob/master/0022-hashed-timelock-agreements/0022-hashed-timelock-agreements.md#trustlines) that can be extended with an automatic settlement mechanism such as a payment channel. |
There was a problem hiding this comment.
should link payment channel to the HTLA doc as well
|
|
||
| This module exports a `makePaymentChannelPlugin` function that | ||
| takes a [Payment Channel Module](#payment-channel-module-api), and returns a | ||
| LedgerPlugin class. Because trustlines and payment channels require maintaining state, |
There was a problem hiding this comment.
'require maintaining state' -> 'are required to maintain state'
| This module exports a `makePaymentChannelPlugin` function that | ||
| takes a [Payment Channel Module](#payment-channel-module-api), and returns a | ||
| LedgerPlugin class. Because trustlines and payment channels require maintaining state, | ||
| users of these plugins must provide a more sophisticated [backend](#backend-api-with-extensions-for-payment-channels) |
There was a problem hiding this comment.
the regular store in the connector can still be provided; an advanced backend is only required if it has to be multi-process
| users of these plugins must provide a more sophisticated [backend](#backend-api-with-extensions-for-payment-channels) | ||
| than is required by other types of plugins. | ||
|
|
||
| - [Installation](#installation) |
There was a problem hiding this comment.
This table of contents should go higher up
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.