diff --git a/elements/README.md b/elements/README.md index 31ce4c4d546..a30b2db03e0 100644 --- a/elements/README.md +++ b/elements/README.md @@ -6,7 +6,7 @@ ## What is Lisk Elements -Lisk Elements is a collection of libraries, each of them implementing some form of blockchain application functionality such as cryptography, transactions, p2p, etc. Each library is designed to be compatible with the [Lisk Protocol](https://research.lisk.com/). +Lisk Elements is a collection of libraries, each of them implementing some form of blockchain application functionality such as cryptography, transactions, p2p, etc. Each library is designed to be compatible with the [Lisk Protocol](https://lisk.com/documentation/lisk-sdk/protocol). Lisk Elements supports the modular architecture of the Lisk SDK, where libraries can be created or modified to suit individual blockchain application requirements. diff --git a/elements/lisk-api-client/README.md b/elements/lisk-api-client/README.md index e9fdf8a5c42..9e733311ada 100644 --- a/elements/lisk-api-client/README.md +++ b/elements/lisk-api-client/README.md @@ -25,4 +25,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/api-client.html diff --git a/elements/lisk-bft/README.md b/elements/lisk-bft/README.md index bc077971291..64205f33e85 100644 --- a/elements/lisk-bft/README.md +++ b/elements/lisk-bft/README.md @@ -25,4 +25,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/bft.html diff --git a/elements/lisk-chain/README.md b/elements/lisk-chain/README.md index b49971434c0..84ae8762a9f 100644 --- a/elements/lisk-chain/README.md +++ b/elements/lisk-chain/README.md @@ -25,4 +25,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/chain.html diff --git a/elements/lisk-client/README.md b/elements/lisk-client/README.md index 623aa8e733b..89ecc32c475 100644 --- a/elements/lisk-client/README.md +++ b/elements/lisk-client/README.md @@ -76,4 +76,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/client.html diff --git a/elements/lisk-codec/README.md b/elements/lisk-codec/README.md index 7e2b7275755..6e4a268538c 100644 --- a/elements/lisk-codec/README.md +++ b/elements/lisk-codec/README.md @@ -40,4 +40,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/codec.html diff --git a/elements/lisk-cryptography/README.md b/elements/lisk-cryptography/README.md index c0e97eee103..aef581df567 100644 --- a/elements/lisk-cryptography/README.md +++ b/elements/lisk-cryptography/README.md @@ -50,4 +50,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/cryptography.html diff --git a/elements/lisk-db/README.md b/elements/lisk-db/README.md index 7ea608f09a4..ff1dbc21cc6 100644 --- a/elements/lisk-db/README.md +++ b/elements/lisk-db/README.md @@ -85,4 +85,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/db.html diff --git a/elements/lisk-genesis/README.md b/elements/lisk-genesis/README.md index 853a9e68f1b..3c06eaa90f5 100644 --- a/elements/lisk-genesis/README.md +++ b/elements/lisk-genesis/README.md @@ -25,4 +25,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/genesis.html diff --git a/elements/lisk-p2p/README.md b/elements/lisk-p2p/README.md index f9c4030e72f..9d5fa7a6648 100644 --- a/elements/lisk-p2p/README.md +++ b/elements/lisk-p2p/README.md @@ -128,4 +128,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/p2p.html diff --git a/elements/lisk-passphrase/README.md b/elements/lisk-passphrase/README.md index 89885f995a8..8b87eee40ee 100644 --- a/elements/lisk-passphrase/README.md +++ b/elements/lisk-passphrase/README.md @@ -25,4 +25,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/passphrase.html diff --git a/elements/lisk-transaction-pool/README.md b/elements/lisk-transaction-pool/README.md index 3d4cff86b5c..2638ac6ac2d 100644 --- a/elements/lisk-transaction-pool/README.md +++ b/elements/lisk-transaction-pool/README.md @@ -25,4 +25,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/transaction-pool.html diff --git a/elements/lisk-transactions/README.md b/elements/lisk-transactions/README.md index b63c1d3bdd9..a25dbdc9b25 100644 --- a/elements/lisk-transactions/README.md +++ b/elements/lisk-transactions/README.md @@ -25,4 +25,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/transactions.html diff --git a/elements/lisk-tree/README.md b/elements/lisk-tree/README.md index fd868efc241..13350b31351 100644 --- a/elements/lisk-tree/README.md +++ b/elements/lisk-tree/README.md @@ -44,4 +44,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/tree.html diff --git a/elements/lisk-utils/README.md b/elements/lisk-utils/README.md index 96aab47743b..79a8eba9e6c 100644 --- a/elements/lisk-utils/README.md +++ b/elements/lisk-utils/README.md @@ -25,4 +25,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/utils.html diff --git a/elements/lisk-validator/README.md b/elements/lisk-validator/README.md index 81f3bd3f9d9..3905869cc03 100644 --- a/elements/lisk-validator/README.md +++ b/elements/lisk-validator/README.md @@ -25,4 +25,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/validator.html diff --git a/framework-plugins/lisk-framework-dashboard-plugin/README.md b/framework-plugins/lisk-framework-dashboard-plugin/README.md index 5bf0dabc0b5..dcb834849ee 100644 --- a/framework-plugins/lisk-framework-dashboard-plugin/README.md +++ b/framework-plugins/lisk-framework-dashboard-plugin/README.md @@ -35,4 +35,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-framework/dashboard-plugin.html diff --git a/framework-plugins/lisk-framework-faucet-plugin/README.md b/framework-plugins/lisk-framework-faucet-plugin/README.md index 045fc4f80a4..34beedd1e57 100644 --- a/framework-plugins/lisk-framework-faucet-plugin/README.md +++ b/framework-plugins/lisk-framework-faucet-plugin/README.md @@ -39,4 +39,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-framework/faucet-plugin.html diff --git a/framework-plugins/lisk-framework-forger-plugin/README.md b/framework-plugins/lisk-framework-forger-plugin/README.md index 7ea909016d0..f27fbd81b0e 100644 --- a/framework-plugins/lisk-framework-forger-plugin/README.md +++ b/framework-plugins/lisk-framework-forger-plugin/README.md @@ -33,4 +33,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-framework/forger-plugin.html diff --git a/framework-plugins/lisk-framework-http-api-plugin/README.md b/framework-plugins/lisk-framework-http-api-plugin/README.md index 899652048c7..7a8e26b810f 100644 --- a/framework-plugins/lisk-framework-http-api-plugin/README.md +++ b/framework-plugins/lisk-framework-http-api-plugin/README.md @@ -46,4 +46,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-framework/http-api-plugin.html diff --git a/framework-plugins/lisk-framework-monitor-plugin/README.md b/framework-plugins/lisk-framework-monitor-plugin/README.md index 72eb276fd9e..3f1dfc162bc 100644 --- a/framework-plugins/lisk-framework-monitor-plugin/README.md +++ b/framework-plugins/lisk-framework-monitor-plugin/README.md @@ -46,4 +46,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-framework/monitor-plugin.html diff --git a/framework-plugins/lisk-framework-report-misbehavior-plugin/README.md b/framework-plugins/lisk-framework-report-misbehavior-plugin/README.md index fade5dfebe3..1ca0dc01030 100644 --- a/framework-plugins/lisk-framework-report-misbehavior-plugin/README.md +++ b/framework-plugins/lisk-framework-report-misbehavior-plugin/README.md @@ -36,4 +36,4 @@ See the License for the specific language governing permissions and limitations under the License. [lisk core github]: https://github.com/LiskHQ/lisk -[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements +[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-framework/report-misbehavior-plugin.html diff --git a/sdk/README.md b/sdk/README.md index 0f3fb006fda..b3902c4d18f 100644 --- a/sdk/README.md +++ b/sdk/README.md @@ -20,13 +20,13 @@ We strictly discourage anyone from using the beta release of the Lisk SDK for an The only application built using the Lisk SDK currently feasible for production usage is [Lisk Core](https://github.com/liskhq/lisk-core), the client of the Lisk network itself. -Please be advised, although we have stabilized the architecture of SDK, we cannot guarantee blockchain created with the beta release of the Lisk SDK will remain compatible with our planned release candidates. +Please be advised, although we have stabilized the architecture of SDK, we cannot guarantee a blockchain application created with the beta release of the Lisk SDK will remain compatible with our planned release candidates. We hope you enjoy building your proof-of-concept blockchain applications using the Lisk SDK, and shall look forward to receiving your feedback and contributions during the beta phase. ## What is the Lisk SDK? -The Lisk SDK aims to provide an easy and reliable software development kit for building blockchain applications which are compatible with the [Lisk Protocol](https://research.lisk.com/). The architecture of the Lisk SDK has been designed so that it can be extended to meet the requirements of a wide variety of blockchain application use-cases. The codebase is written entirely in JavaScript, which means for a majority of developers, no significant change of tools or mindset is required to get started. The Lisk SDK makes every effort to allow developers to focus simply and purely on writing the code that matters to their own blockchain application, and nothing more. +The Lisk SDK aims to provide an easy and reliable software development kit for building blockchain applications which are compatible with the [Lisk Protocol](https://lisk.com/documentation/lisk-sdk/protocol). The architecture of the Lisk SDK has been designed so that it can be extended to meet the requirements of a wide variety of blockchain application use-cases. The codebase is written entirely in JavaScript, which means for a majority of developers, no significant change of tools or mindset is required to get started. The Lisk SDK makes every effort to allow developers to focus simply and purely on writing the code that matters to their own blockchain application, and nothing more. ## Usage