Skip to content

Commit

Permalink
Update readme file with new folders (#1383)
Browse files Browse the repository at this point in the history
* fix: update readme file

* fix: fix typo

* fix: fix typo
  • Loading branch information
fabiorigam authored Oct 3, 2024
1 parent d601cdc commit b4eb56d
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@

Welcome to the VeChain SDK repository! Here's a breakdown of our organized structure:

- `./apps`: Explore a suite of sample applications that demonstrate the versatility and power of our SDK in real-world scenarios. From Next.js to Node.js, HardHat, and CloudFlare, these examples serve as practical guides to kickstart your development journey.
- `./docker`: Streamline your development and deployment with our comprehensive Docker configurations. This directory offers Dockerfiles and Docker Compose setups designed to create consistent, reproducible environments.
- `./docs`: Your go-to destination for comprehensive documentation. Explore demonstrative examples showcasing the prowess of our SDK. Knowledge is power, and our docs are here to enlighten your path.
- `./packages`: A hub for our monorepo packages, each serving a distinct purpose:
- `./packages/core`: The heart of the SDK, housing essential modules for fundamental operations like hashing and cryptography. Dive into the core for the building blocks of your decentralized dreams.
Expand All @@ -29,8 +31,9 @@ Welcome to the VeChain SDK repository! Here's a breakdown of our organized struc
- `./packages/logging`: The logging package provides a simple and easy-to-use logging system for the VeChain SDK. This module is dedicated to managing and customizing logs within the SDK, ensuring your development experience remains transparent and insightful.
- `./packages/network`: Embark on a journey through the network module, your gateway to all things related to blockchain interaction and transaction dissemination. Here, the VeChain SDK connects you seamlessly to the VeChainThor blockchain.
- `./packages/rpc-proxy`: This package is designed to bridge the gap between Thor's RESTful API and Ethereum's JSON-RPC.
- `./scripts`: Enhance your workflow efficiency with our collection of utility scripts. Located here are tools for tasks like automated testing, pre-release preparations, and file validation.

Explore, experiment, and let the VeChain SDK empowers your blockchain adventures!
Explore, experiment, and let the VeChain SDK empower your blockchain adventures!

## SDK Development

Expand Down

1 comment on commit b4eb56d

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Test Coverage

Summary

Lines Statements Branches Functions
Coverage: 97%
97.79% (4171/4265) 95.79% (1366/1426) 97.09% (870/896)
Title Tests Skipped Failures Errors Time
core 782 0 💤 0 ❌ 0 🔥 1m 50s ⏱️
network 731 0 💤 0 ❌ 0 🔥 4m 45s ⏱️
errors 42 0 💤 0 ❌ 0 🔥 16.933s ⏱️

Please sign in to comment.