Skip to content

Commit

Permalink
docs: address review comments for grammar and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
CJ42 committed May 7, 2024
1 parent 00a3ec8 commit f14be19
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center">
<h1 align="center"><strong>@erc725/erc725.js</strong></h1>
<p align="center">Allows for to read, encode and decode data from <a href="https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-2-ERC725YJSONSchema.md">ERC725Y</a> compliant contracts using ERC725Y JSON schemas.</p>
<p align="center">Allows to read, encode and decode data from <a href="https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-2-ERC725YJSONSchema.md">ERC725Y</a> compliant contracts using ERC725Y JSON schemas.</p>
</p>

<p align="center">
Expand Down Expand Up @@ -130,7 +130,7 @@ const erc725 = new ERC725(schemas, address, RPC_URL, config);

## Usage

> See the **Getting Started** pages for more examples on how to use )_erc725.js_
> See the **Getting Started** pages for more examples on how to use _erc725.js_
```js
await myErc725.getOwner();
Expand Down
12 changes: 6 additions & 6 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ npm install @erc725/erc725.js
There are 3 main ways to use _erc725.js_.

### Option 1: using with schema only
### Option 1: use a schema for encoding / decoding data

Create an instance of `ERC725` with just a [schema](https://docs.lukso.tech/tools/erc725js/schemas): **useful for just encoding / decoding data.**
Create an instance of `ERC725` with just a [schema](https://docs.lukso.tech/tools/erc725js/schemas). **Useful for just encoding / decoding data.**

```js
import ERC725, { ERC725JSONSchema } from '@erc725/erc725.js';
Expand All @@ -53,9 +53,9 @@ const schemas: ERC725JSONSchema[] = [
const erc725 = new ERC725(schemas);
```

### Option 2: connect a contract to fetch + decode data from
### Option 2: connect to a smart contract to fetch/decode data

Same as option 1 where you can pass an ERC725Y contract address, an RPC URL and some additional confits (IPFS gateway): **useful to fetch and decode data automatically from a contract deployed on a network**.
Same as option 1 where you can pass an ERC725Y contract address, an RPC URL and some additional configurations (e.g: IPFS gateway). **Useful to fetch and decode data automatically from a contract deployed on a network**.

```js
import ERC725, { ERC725JSONSchema } from '@erc725/erc725.js';
Expand Down Expand Up @@ -95,9 +95,9 @@ const config = {
const erc725 = new ERC725(schemas, address, RPC_URL, config);
```

### Option 3: use only specific functions
### Option 3: use specific functions or static methods

You can import only specific functions (or using static methods of the `ERC725` class): **useful when needing only specific functionalities for your dApp (_e.g:_ decoding `VerifiableURI`, encoding dynamic keys).**
You can import specific functions or use static methods from the `ERC725` class. **Useful to add only specific functionalities to your dApp (_e.g:_ decoding `VerifiableURI`, encoding dynamic keys).**

```js
import {
Expand Down

0 comments on commit f14be19

Please sign in to comment.