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

Added comaparison for package size #6852

Closed
wants to merge 4 commits into from
Closed

Added comaparison for package size #6852

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aaf92d4
Added comaparison for package size
DrParadox05 Mar 3, 2024
9c572ab
Added advantages over other libraries
DrParadox05 Mar 4, 2024
1dac5cb
added packge size in minified gzipped
DrParadox05 Mar 7, 2024
c27cf95
Update introduction.md
SantiagoDevRel Apr 23, 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
Binary file added docs/docs/guides/getting_started/PackageSizeComparison.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 11 additions & 1 deletion docs/docs/guides/getting_started/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ The following documentation will guide you through different use cases of Web3.j
- Custom Output formatters
- In compliance with Eth EL API

![Comparison of various package sizes](PackageSizeComparison.png)

## Packages

Web3.js is modular, consisting of several packages, each serving specific functionalities. If you have specific tasks in mind, you don't need to install the entire Web3 library. Instead, selectively install the package that suits your requirements for a more efficient development experience. Here is an overview of the available packages:
Expand Down Expand Up @@ -55,4 +57,12 @@ Web3.js is modular, consisting of several packages, each serving specific functi

- **Web3 Errors:** Web3 Errors has error codes and common error classes that are used by other Web3 packages.

- **Web3 RPC Methods:** This is for advanced uses for building more lightweight applications. It has functions for making RPC requests to Ethereum using a given provider.
- **Web3 RPC Methods:** This is for advanced uses for building more lightweight applications. It has functions for making RPC requests to Ethereum using a given provider.

## Advantages over other libraries

- **Extensive Documentation and Community**: Being one of the earliest Ethereum libraries, Web3.js benefits from extensive documentation and a large, active community. Web3.js is widely adopted and has been thoroughly tested in various production environments and is compatible with a broad range of other tools and services in the Ethereum ecosystem.

- **Modular Design**: Web3.js is designed to be modular, meaning it allows developers to use specific packages according to their needs. This may lead to smaller bundle sizes and faster load times for web applications.

- **Active Development and Support**: Web3.js sees regular updates and active development. This support is crucial for developers needing assurance that the library they're using will keep pace with the evolving Ethereum landscape.
Loading