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

Updated README.md #6804

Merged
merged 3 commits into from
Feb 12, 2024
Merged

Updated README.md #6804

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1392ec9
Updated README.md
DrParadox05 Feb 9, 2024
941bfb4
Put the features on top
SantiagoDevRel Feb 9, 2024
c0b22c5
Update packages/web3/README.md
DrParadox05 Feb 9, 2024
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
21 changes: 18 additions & 3 deletions packages/web3/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,24 @@
[![NPM Package][npm-image]][npm-url]
[![Downloads][downloads-image]][npm-url]

This is the main package of [web3.js](repo).

`web3` contains the ideal setup for a Web3.js package.
This is the main package of [web3.js](repo), it contains a collection of comprehensive [TypeScript](https://www.typescriptlang.org/) libraries for Interaction with the [Ethereum JSON RPC API](https://ethereum.org/developers/docs/apis/json-rpc) and utility functions.

## Features

- **Web3.js Plugins](https://docs.web3js.org/guides/web3_plugin_guide/)**: Enhance or add any functionality by creating scalable web3 plugins for any project.
- **Abstractions over the [JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc)**: Simplifying interaction for your Developer Experience.
- **Language aligned to the official [Ethereum terminology](https://ethereum.org/en/glossary**
- **Tree-shaking focus**: Include only what you need during bundling for optimized performance.
- **Dynamic contract types and full API in TypeScript**: Enforced with strict types for enhanced security and safety.
- **Complete utilities and functionalities for all your Ethereum needs**
- **More efficient ABI Encoder & Decoder**
- **Extensive [documentation](https://docs.web3js.org/) with guides and APIs**
- **Large collection of test cases**
- **First-class APIs for interacting with [Smart Contracts](https://ethereum.org/en/glossary#smart-contract**
- **ESM and CJS module builds**: Support for both ECMAScript module and CommonJS module builds for flexible integration with various project setups.
- **Contracts dynamic types](https://docs.web3js.org/guides/smart_contracts/infer_contract_types/) & full API in TypeScript**
- **Using native BigInt instead of large BigNumber libraries**: Use native BigInt for improved efficiency compared to using large external BigNumber libraries.
- **Custom Output formatters**: Format any returned value to be a string, number, BigInt, etc., providing flexibility in handling output data.

## Installation

Expand Down
Loading