Proposal: Add beginner-friendly examples to README

[goldman0020]

Hi TronWeb team,

I'm a JavaScript developer and I noticed that the README could use more examples for beginners. I'd like to propose adding a simple "Getting Started" section with code examples showing:

1. How to connect to TronWeb (with TronLink and without)
2. How to get an account balance
3. How to send a TRX transaction

This would help new developers adopt TronWeb more easily.

I'm willing to work on this and submit a Pull Request if you're interested.

Let me know what you think!

[goldman0020]

I've already prepared a draft for this. I'll submit a PR once I get the green light from the team.

[Stan202310]

We already have documentation for this. Feel free to check it out. https://tronweb.network/docu/docs/intro/

[goldman0020]

Hi team

Thanks for the quick reply and for pointing me to the official docs.

You're absolutely right – the basics like installation, instantiation, and network connection are already well covered there. I should have checked more thoroughly before my initial message.

However, while going through the docs, I noticed a few practical gaps that I believe would be valuable additions for developers who are just getting started. These are common use cases that aren't currently covered with working examples:

What's missing:

1. TRC-20 Token Interactions – No examples for reading token balances or transferring tokens (e.g., USDT). This is probably the most common task developers need.
2. Error Handling Patterns – No dedicated section showing how to handle different error types (invalid address, insufficient balance, timeouts) with try/catch.
3. Event Listening – No examples for subscribing to contract events like Transfer. This is essential for dApps.
4. Mock Contract for Testnet – A deployable Mock USDT contract on Shasta would let developers test TRC-20 interactions without risking real funds.
5. Quick Test Script – A ready-to-run script to verify the entire setup works.

My plan:

I'll prepare a focused PR that adds only these new sections to the documentation. This way, we avoid duplicating what's already there and keep the docs clean.

The examples will be practical, copy-paste ready, and include clear security warnings (especially about private keys).

Let me know if you're open to these additions, and I'll get the PR ready.

Thanks for your time.

Ali Kaharkaboodi

[Stan202310]

1. https://tronweb.network/docu/docs/Transfer%20Token#transfer-trc20-token
2. https://tronweb.network/docu/docs/references/error-codes
3. We recommend polling for events yourself.
4. You can deploy your own contracts on a Testnet.
5. You need to implement this on your own dapp.

[goldman0020]

@Stan202310 Thanks for the guidance.

I've submitted a PR that adds a practical testing guide for TRC-20 tokens on Shasta testnet. It includes the full Solidity source code of the Mock USDT contract (since it's not verified on-chain), a complete test script, and security best practices.

PR Link: #714

Looking forward to your review.

[Stan202310]

And we also have a demo website for TRON. Check it out: https://github.com/tronweb3/tron-dapp-quickstart

[goldman0020]

@Stan202310 Thanks for the link – it's a great full‑stack DApp template.

The goal of my PR is complementary: a minimal, copy‑paste snippet for developers to quickly verify their TronWeb setup and test TRC‑20 logic (balanceOf, transfer, mint) without the overhead of a full React/Vite project. It’s focused purely on the “TronWeb logic” itself.

I believe having this concise example in docs/examples/ alongside the quickstart would lower the barrier for new developers – a fast way to test core concepts before building a full DApp.

Happy to adjust anything to better fit the contribution guidelines. Let me know your thoughts!