Skip to content

Commit

Permalink
docu update
Browse files Browse the repository at this point in the history
  • Loading branch information
neodix42 committed Oct 12, 2022
1 parent 6f2f98b commit 1de9524
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 14 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Java SDK for The Open Network ([TON])

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
![GitHub last commit](https://img.shields.io/github/last-commit/neodiX42/ton-java-temp1)
![visitors](https://visitor-badge.glitch.me/badge?page_id=neodiX42.ton-java-temp1.readme&left_color=gray&right_color=red)
![GitHub last commit](https://img.shields.io/github/last-commit/neodiX42/ton-java)
![visitors](https://visitor-badge.glitch.me/badge?page_id=neodiX42.ton-java.readme&left_color=gray&right_color=red)
[![Based on TON][ton-svg]][ton]

Java libraries for interacting with TON blockchain.

✅ If you somehow got here today, keep in mind that this library is not ready for usage.
✅ If you somehow got here today, keep in mind that this library is not ready for usage.
Maven and Jitpack links won't work!

## Maven [![Maven Central][maven-central-svg]][maven-central]
Expand All @@ -29,17 +30,19 @@ Maven and Jitpack links won't work!
</repository>
</repositories>
```

```xml
<dependency>
<groupId>com.github.neodiX42</groupId>
<artifactId>ton-java-temp1</artifactId>
<artifactId>ton-java</artifactId>
<version>0.0.1</version>
</dependency>
```

You can use each sub-module individualy. Click the module below to get more details.

* [Tonlib](tonlib/README.md) - use external Tonlib shared library to communicate with TON blockchain.
* [SmartContract](smartcontract/README.md) - create and deploy custom and predefined smart-contracts.
* [SmartContract](smartcontract/README.md) - create and deploy custom and predefined smart-contracts.
* [Cell](cell/README.md) - create, read and manipulate Bag of Cells.
* [BitString](bitstring/README.md) - construct bitstrings. All data in Cells stored in bitstrings.
* [Address](address/README.md) - create and parse TON wallet addresses.
Expand All @@ -57,12 +60,13 @@ You can use each sub-module individualy. Click the module below to get more deta
* ✅ Send external message
* ✅ Get block transactions
* ✅ Get account transactions
* ✅ Deploy contracts and send external messages
* ✅ Wallet operations (Simple, V2, V3, V4)
* ✅ Deploy contracts and send external messages using Tonlib
* ✅ Wallet operations (Simple, V2, V3, V4, Lockup)
* ✅ Cell hashmap serialization / deserialization
### Todo

### Todo

* Support tuple and list as arguments for runMethod
* Test Lockup wallet with allowed destinations
* Add TON DNS support
* Add TON Payment channel support
* Add FT (Jetton) and NFT tokens support
Expand All @@ -72,8 +76,13 @@ You can use each sub-module individualy. Click the module below to get more deta
<!-- Badges -->

[maven-central-svg]: https://img.shields.io/maven-central/v/org.ton.java/sdk

[maven-central]: https://mvnrepository.com/artifact/org.ton.java/sdk

[jitpack-svg]: https://jitpack.io/v/neodiX42/ton-java.svg

[jitpack]: https://jitpack.io/#neodiX42/ton-java/sdk

[ton-svg]: https://img.shields.io/badge/Based%20on-TON-blue

[ton]: https://ton.org
10 changes: 5 additions & 5 deletions sdk/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@
<packaging>pom</packaging>

<name>TON Java SDK</name>
<description>Construct bag of cells, slices, bitstrings, create standard and custom smart contracts and send them to
<description>Construct bag of cells, slices, bitStrings, create standard and custom smart contracts and send them to
the blockchain using Tonlib shared library.
</description>
<url>https://github.com/neodiX42/ton-java-temp1</url>
<url>https://github.com/neodiX42/ton-java</url>

<licenses>
<license>
Expand All @@ -34,9 +34,9 @@
</developers>

<scm>
<connection>scm:git:git://github.com/neodiX42/ton-java-temp1.git</connection>
<developerConnection>scm:git:ssh://github.com/neodiX42/ton-java-temp1.git</developerConnection>
<url>https://github.com/neodiX42/ton-java-temp1/tree/main</url>
<connection>scm:git:git://github.com/neodiX42/ton-java.git</connection>
<developerConnection>scm:git:ssh://github.com/neodiX42/ton-java.git</developerConnection>
<url>https://github.com/neodiX42/ton-java/tree/main</url>
</scm>

<dependencies>
Expand Down

0 comments on commit 1de9524

Please sign in to comment.