Skip to content

Commit 831c783

Browse files
frank0170Andreas Frank
andauthored
Added docs for sdk4j (#66)
* Added docs for sdk4j * Added javadocs for sdk4j * fix: fixed docker * fix: fixed docs --------- Co-authored-by: Andreas Frank <andreas.frank@vechain.org>
1 parent 908f365 commit 831c783

File tree

11 files changed

+1788
-34
lines changed

11 files changed

+1788
-34
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@
44

55
A SDK toolkit for JDK to call VeChainThor Restful API.
66

7+
## 📚 Documentation
8+
9+
For comprehensive integration guides, API references, and examples, visit our detailed documentation:
10+
11+
- **[Partner Integration Guide](docs/MAIN_DOCUMENTATION.md)** - Complete guide with all SDK functions and practical examples
12+
- **[Model Classes Reference](docs/MODEL_CLASSES_REFERENCE.md)** - Reference for all data models and types
13+
- **[Multi-Party Payment Guide](docs/PROTOTYPE_CONTRACT_GUIDE.md)** - MPP implementation guide
14+
15+
The documentation includes dynamic links to Javadoc for up-to-date type and field references.
16+
717
> [!WARNING]
818
> This repository is not actively maintained.
919
>

docker-compose.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ services:
3030
networks:
3131
- vechain-thor
3232

33-
3433
networks:
3534
vechain-thor:
3635
driver: bridge
37-
name: vechain-thor
36+
name: vechain-thor

0 commit comments

Comments
 (0)