Skip to content

Commit

Permalink
fix: installation instructions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
CJ42 committed Jan 14, 2025
1 parent 352dfd8 commit 3390a6f
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 13 deletions.
10 changes: 8 additions & 2 deletions packages/lsp-smart-contracts/README.md
Original file line number Diff line number Diff line change
@@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion packages/lsp11-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
7 changes: 4 additions & 3 deletions packages/lsp17-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
2 changes: 1 addition & 1 deletion packages/lsp17contractextension-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Package for the LSP17 Contract Extension

## Installation

```bash
```console
npm install @lukso/lsp17contractextension-contracts
```

Expand Down
2 changes: 1 addition & 1 deletion packages/lsp26-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Package for the LSP26 Follower System standard.

## Installation

```bash
```console
npm i @lukso/lsp26-contracts
```

Expand Down
2 changes: 1 addition & 1 deletion packages/lsp3-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Package for the LSP3 Profile Metadata standard.

## Installation

```bash
```console
npm install @lukso/lsp3-contracts
```

Expand Down
4 changes: 2 additions & 2 deletions packages/lsp4-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion packages/lsp7-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Package for the LSP7 Digital Asset standard.

## Installation

```bash
```console
npm install @lukso/lsp7-contracts
```

Expand Down
2 changes: 1 addition & 1 deletion packages/lsp8-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Package for the LSP8 Identifiable Digital Asset Standard.

## Installation

```bash
```console
npm install @lukso/lsp8-contracts
```

Expand Down

0 comments on commit 3390a6f

Please sign in to comment.