From 3390a6fe659efecb0c6c12e88263c1996d714fae Mon Sep 17 00:00:00 2001 From: CJ42 Date: Tue, 14 Jan 2025 16:29:37 +0000 Subject: [PATCH] fix: installation instructions in README --- packages/lsp-smart-contracts/README.md | 10 ++++++++-- packages/lsp11-contracts/README.md | 2 +- packages/lsp17-contracts/README.md | 7 ++++--- packages/lsp17contractextension-contracts/README.md | 2 +- packages/lsp26-contracts/README.md | 2 +- packages/lsp3-contracts/README.md | 2 +- packages/lsp4-contracts/README.md | 4 ++-- packages/lsp7-contracts/README.md | 2 +- packages/lsp8-contracts/README.md | 2 +- 9 files changed, 20 insertions(+), 13 deletions(-) diff --git a/packages/lsp-smart-contracts/README.md b/packages/lsp-smart-contracts/README.md index 4f6131689..77c3633b4 100644 --- a/packages/lsp-smart-contracts/README.md +++ b/packages/lsp-smart-contracts/README.md @@ -1,10 +1,16 @@ # `@lukso/lsp-smart-contracts` -Package for the LSP Smart Contracts. +This is the _"umbrella"_ package for the LSP smart contracts. It contains all the individual `@lukso/lspN-contracts` packages (where `N` is an LSP number) as dependencies. + +## Installation + +```console +npm install @lukso/lsp-smart-contracts +``` ## Available Constants & Types -The `@lukso/lsp-smart-contracts` npm package contains useful constants such as InterfaceIds, and ERC725Y Data Keys related to the LSP Standards. You can import and access them as follow: +The `@lukso/lsp-smart-contracts` npm package contains useful constants such as interface IDs, and ERC725Y data keys related to the LSP Standards. You can import and access them as follows: ```js import { diff --git a/packages/lsp11-contracts/README.md b/packages/lsp11-contracts/README.md index b6015209d..dd5d78b75 100755 --- a/packages/lsp11-contracts/README.md +++ b/packages/lsp11-contracts/README.md @@ -4,7 +4,7 @@ Package for the [LSP11 Social Recovery](https://github.com/lukso-network/LIPs/bl ## Installation -```bash +```console npm install @lukso/lsp11-contracts ``` diff --git a/packages/lsp17-contracts/README.md b/packages/lsp17-contracts/README.md index 15c7d8abf..5382f82ce 100644 --- a/packages/lsp17-contracts/README.md +++ b/packages/lsp17-contracts/README.md @@ -2,12 +2,13 @@ Package for the LSP17 Extensions, that includes the following extensions: -- the `Extension4337` extension, which contains the `validateUserOp` function from the [`ERC4337` standard](https://eips.ethereum.org/EIPS/eip-4337). -- the `OnERC721ReceivedExtension` extension that contains the `onERC721Received` function from the [`ERC721` standard](https://eips.ethereum.org/EIPS/eip-721). +- `Extension4337` extension, which contains the `validateUserOp` function from the [`ERC4337` standard](https://eips.ethereum.org/EIPS/eip-4337). +- `OnERC721ReceivedExtension` extension that contains the `onERC721Received` function from the [`ERC721` standard](https://eips.ethereum.org/EIPS/eip-721). +- `ERCTokenCallbacks` extension that contains implemented callback functions with valid returned values from ERC721, ERC1155 and ERC777 to support receiving tokens via the transfer functions that trigger these callbacks. ## Installation -```bash +```console npm install @lukso/lsp17-contracts ``` diff --git a/packages/lsp17contractextension-contracts/README.md b/packages/lsp17contractextension-contracts/README.md index 3a242e2fe..cd1475d5d 100644 --- a/packages/lsp17contractextension-contracts/README.md +++ b/packages/lsp17contractextension-contracts/README.md @@ -4,7 +4,7 @@ Package for the LSP17 Contract Extension ## Installation -```bash +```console npm install @lukso/lsp17contractextension-contracts ``` diff --git a/packages/lsp26-contracts/README.md b/packages/lsp26-contracts/README.md index 9db795db9..e0b819a1a 100644 --- a/packages/lsp26-contracts/README.md +++ b/packages/lsp26-contracts/README.md @@ -4,7 +4,7 @@ Package for the LSP26 Follower System standard. ## Installation -```bash +```console npm i @lukso/lsp26-contracts ``` diff --git a/packages/lsp3-contracts/README.md b/packages/lsp3-contracts/README.md index 95d5e18de..e826b346c 100644 --- a/packages/lsp3-contracts/README.md +++ b/packages/lsp3-contracts/README.md @@ -4,7 +4,7 @@ Package for the LSP3 Profile Metadata standard. ## Installation -```bash +```console npm install @lukso/lsp3-contracts ``` diff --git a/packages/lsp4-contracts/README.md b/packages/lsp4-contracts/README.md index 491921091..c7e81acef 100644 --- a/packages/lsp4-contracts/README.md +++ b/packages/lsp4-contracts/README.md @@ -4,13 +4,13 @@ Package for the LSP4 Digital Asset Metadata standard. ## Installation -```bash +```console npm install @lukso/lsp4-contracts ``` ## Available Constants & Types -The `@lukso/lsp4-contracts` npm package contains useful constants such as ERC725Y data keys related to the LSP4 Standard. You can import and access them as follow: +The `@lukso/lsp4-contracts` npm package contains useful constants such as ERC725Y data keys related to the LSP4 Standard. You can import and access them as follows: ```js import { diff --git a/packages/lsp7-contracts/README.md b/packages/lsp7-contracts/README.md index ef7dfc5d3..0c868aaa2 100644 --- a/packages/lsp7-contracts/README.md +++ b/packages/lsp7-contracts/README.md @@ -4,7 +4,7 @@ Package for the LSP7 Digital Asset standard. ## Installation -```bash +```console npm install @lukso/lsp7-contracts ``` diff --git a/packages/lsp8-contracts/README.md b/packages/lsp8-contracts/README.md index 3deb7767d..4c7bcefc1 100644 --- a/packages/lsp8-contracts/README.md +++ b/packages/lsp8-contracts/README.md @@ -4,7 +4,7 @@ Package for the LSP8 Identifiable Digital Asset Standard. ## Installation -```bash +```console npm install @lukso/lsp8-contracts ```