Initial commit
This commit is contained in:
57
QUICK_START.md
Normal file
57
QUICK_START.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# Quick Start Guide
|
||||
|
||||
Get started with Chain 138 enablement in 5 minutes.
|
||||
|
||||
## 1. Install Dependencies
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
## 2. Build Packages
|
||||
|
||||
```bash
|
||||
pnpm build
|
||||
```
|
||||
|
||||
## 3. (Optional) Run Tests
|
||||
|
||||
```bash
|
||||
cd apps/smoke-tests
|
||||
cp .env.example .env
|
||||
# Edit .env with your TEST_PRIVATE_KEY
|
||||
pnpm test
|
||||
```
|
||||
|
||||
## 4. Use in Your Code
|
||||
|
||||
```typescript
|
||||
import { chain138 } from '@dbis-thirdweb/chain';
|
||||
import { ThirdwebSDK } from '@thirdweb-dev/sdk';
|
||||
|
||||
const sdk = new ThirdwebSDK(chain138, privateKey);
|
||||
// Use SDK as normal - Chain 138 is fully configured!
|
||||
```
|
||||
|
||||
## Package Quick Links
|
||||
|
||||
- **Chain Definition**: `@dbis-thirdweb/chain`
|
||||
- **Wallets**: `@dbis-thirdweb/wallets`
|
||||
- **Payments (x402)**: `@dbis-thirdweb/x402`
|
||||
- **Bridge**: `@dbis-thirdweb/bridge`
|
||||
- **Tokens**: `@dbis-thirdweb/tokens`
|
||||
- **AI**: `@dbis-thirdweb/ai`
|
||||
- **HTTP API**: `@dbis-thirdweb/http-api`
|
||||
|
||||
See individual package READMEs for detailed usage examples.
|
||||
|
||||
## Documentation
|
||||
|
||||
- [README.md](README.md) - Project overview
|
||||
- [SETUP.md](SETUP.md) - Detailed setup guide
|
||||
- [PROJECT_STATUS.md](PROJECT_STATUS.md) - Current project status
|
||||
- [CHANGELOG.md](CHANGELOG.md) - Version history
|
||||
|
||||
## Need Help?
|
||||
|
||||
Check package-specific READMEs in `packages/*/README.md` or the main [SETUP.md](SETUP.md) guide.
|
||||
Reference in New Issue
Block a user