Skip to content

Commit 38010ee

Browse files
authored
Merge pull request #25 from ethersphere/docs
feat: Docs
2 parents d58b77a + 2ad77b3 commit 38010ee

9 files changed

Lines changed: 2525 additions & 0 deletions

docs/README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Swarm Upload Documentation
2+
3+
Welcome to the comprehensive guide for uploading files to the Swarm network using our application. This documentation covers all available upload features and options.
4+
5+
## 📚 Available Guides
6+
7+
### Core Upload Features
8+
9+
- **[Single File Upload](./single-file-upload.md)** - Basic file upload functionality
10+
- **[Multiple File Upload](./multiple-file-upload.md)** - Upload multiple files to the same stamp
11+
- **[ZIP File Upload](./zip-file-upload.md)** - Upload and process ZIP archives
12+
13+
### Advanced Features
14+
15+
- **[Webpage Upload](./webpage-upload.md)** - Create websites from TAR/ZIP files
16+
- **[NFT Collection Upload](./nft-collection-upload.md)** - Upload entire NFT collections with automatic metadata processing
17+
- **[Archive Processing](./archive-processing.md)** - How ZIP, TAR, and GZ files are handled
18+
19+
### Technical Guides
20+
21+
- **[Architecture](./architecture.md)** - Project architecture and third-party integrations
22+
- **[Postage Stamps](./postage-stamps.md)** - Understanding and managing storage stamps
23+
- **[File Formats & Limits](./file-formats-limits.md)** - Supported formats and size limitations
24+
- **[Troubleshooting](./troubleshooting.md)** - Common issues and solutions
25+
26+
## 🚀 Quick Start
27+
28+
1. **Connect your wallet** to get started
29+
2. **Purchase or select a postage stamp** for storage
30+
3. **Choose your upload type**:
31+
- Single file for individual files
32+
- Multiple files for batch uploads
33+
- ZIP with special processing options
34+
4. **Configure options** based on your needs
35+
5. **Upload and get your Swarm references**
36+
37+
## 🔗 Useful Links
38+
39+
- [Swarm Network Documentation](https://docs.ethswarm.org/)
40+
- [Bee API Documentation](https://docs.ethswarm.org/docs/api-reference/)
41+
- [bzz.link Gateway](https://bzz.link/)
42+
43+
## 📋 Feature Overview
44+
45+
| Feature | File Types | Special Processing | Use Case |
46+
| -------------- | ---------- | --------------------------- | -------------------- |
47+
| Single File | Any | Optional archive extraction | Individual files |
48+
| Multiple Files | Any | Sequential upload | Batch operations |
49+
| ZIP Upload | .zip | Extract → TAR conversion | Archive distribution |
50+
| Webpage Upload | .tar, .zip | Web server configuration | Static websites |
51+
| NFT Collection | .zip | Metadata URL rewriting | NFT projects |
52+
53+
## 🛠️ Technical Requirements
54+
55+
- **Wallet**: MetaMask or compatible Web3 wallet
56+
- **Network**: Gnosis Chain (for postage stamps)
57+
- **Browser**: Modern browser with JavaScript enabled
58+
- **Files**: See individual guides for format requirements
59+
60+
---
61+
62+
_For detailed information on each feature, click on the links above or browse the individual guide files._

0 commit comments

Comments
 (0)