Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update readme for absolute links in avail-js npm registry #671

Merged
merged 1 commit into from
Sep 27, 2024
Merged

update readme for absolute links in avail-js npm registry #671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions avail-js/docs/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion avail-js/docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.0.1",
"description": "Shows a basic usage of the Avail-js SDK",
"dependencies": {
"avail-js-sdk": "^0.2.16"
"avail-js-sdk": "^0.2.17"
},
"resolutions": {
"ws": ">=8.17.1"
Expand Down
9 changes: 5 additions & 4 deletions avail-js/examples/next-example/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion avail-js/examples/next-example/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"@types/react": "18.2.67",
"@types/react-dom": "18.2.22",
"autoprefixer": "10.4.18",
"avail-js-sdk": "^0.2.16",
"avail-js-sdk": "^0.2.17",
"eslint": "8.57.0",
"eslint-config-next": "14.1.4",
"next": "^14.2.12",
Expand Down
9 changes: 5 additions & 4 deletions avail-js/examples/node-examples/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion avail-js/examples/node-examples/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"validium": "npm run build && node build/node-examples/src/validium.js"
},
"dependencies": {
"avail-js-sdk": "^0.2.16",
"avail-js-sdk": "^0.2.17",
"ethers": "^6.13.2"
},
"devDependencies": {
Expand Down
13 changes: 7 additions & 6 deletions avail-js/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion avail-js/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "avail-js-sdk",
"version": "0.2.16",
"version": "0.2.17",
"description": "Avail library of functions to interact with blockchain and manipulate transactions",
"main": "./build/index.js",
"scripts": {
Expand Down
18 changes: 9 additions & 9 deletions avail-js/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,21 @@ This SDK is split into two main parts:

### Folder Structure

- **[`src/chain/`](./src/chain/)**: Contains the basics to initialize an API with the chain, serving as the Polkadot JS wrapper.
- **[`src/helpers/`](./src/helpers/)**: Includes basic helper functions that facilitate various tasks.
- **[`src/spec/`](./src/spec/)**: All types, RPC, and signed extensions related to Avail. These are crucial for interacting with the chain, including decoding chain data, transactions, and initiating transactions.
- **[`src/sdk/`](./src/sdk/)**: Contains all classes related to the SDK, representing the opinionated part of Avail-JS-SDK.
- **[`src/chain/`](https://github.com/availproject/avail/tree/main/avail-js/src/chain/)**: Contains the basics to initialize an API with the chain, serving as the Polkadot JS wrapper.
- **[`src/helpers/`](https://github.com/availproject/avail/tree/main/avail-js/src/helpers/)**: Includes basic helper functions that facilitate various tasks.
- **[`src/spec/`](https://github.com/availproject/avail/tree/main/avail-js/src/spec/)**: All types, RPC, and signed extensions related to Avail. These are crucial for interacting with the chain, including decoding chain data, transactions, and initiating transactions.
- **[`src/sdk/`](https://github.com/availproject/avail/tree/main/avail-js/src/sdk/)**: Contains all classes related to the SDK, representing the opinionated part of Avail-JS-SDK.

### Additional Information

- **[`./examples/README.md`](./examples/README.md)**: Refer to this for examples utilizing the Polkadot JS wrapper.
- **[`./docs/README.md`](./docs/README.md)**: This contains documentation, interfaces, and examples using the opinionated SDK.
- **[`./examples/README.md`](https://github.com/availproject/avail/tree/main/avail-js/examples/readme.md)**: Refer to this for examples utilizing the Polkadot JS wrapper.
- **[`./docs/README.md`](https://github.com/availproject/avail/tree/main/avail-js/docs/README.md)**: This contains documentation, interfaces, and examples using the opinionated SDK.

## Documentation and examples

- [Wrapper node usage](./examples/node-examples)
- [Wrapper web usage](./examples/next-example)
- [SDK node usage](./docs/)
- [Wrapper node usage](https://github.com/availproject/avail/tree/main/avail-js/examples/node-examples)
- [Wrapper web usage](https://github.com/availproject/avail/tree/main/avail-js/examples/next-example)
- [SDK node usage](https://github.com/availproject/avail/tree/main/avail-js/docs)

## Error Reporting

Expand Down
Loading