From d045f4e65152628e255da0c7769c510adc4f1495 Mon Sep 17 00:00:00 2001 From: Vladimir Lebedev Date: Fri, 29 Dec 2023 10:30:52 +0700 Subject: [PATCH] Update README.md --- README.md | 66 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index aca3426..1a7047e 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,2 @@ -## 💎 ton3-core - -[![npm](https://img.shields.io/npm/v/ton3-core)](https://www.npmjs.com/package/ton3-core) -![GitHub top language](https://img.shields.io/github/languages/top/tonstack/ton3-core) -[![Coverage Status](https://coveralls.io/repos/github/tonstack/ton3-core/badge.svg?branch=main)](https://coveralls.io/github/tonstack/ton3-core?branch=main) -[![TON](https://img.shields.io/badge/based%20on-The%20Open%20Network-blue)](https://ton.org/) - -ton3-core is a core package of ton3 inspired by [tonweb](https://github.com/toncenter/tonweb) to work with [TON blockchain](https://ton.org).\ -Visit [documentation](./docs/) to see API reference. -> :warning: Work in progress, API can (and most likely will) be changed! This is not production ready version yet. - -## How to install -``` -npm i ton3-core -``` - -## Simple usage -```typescript -import { BOC, Builder, Mnemonic } from 'ton3-core' - -const mnemonic = new Mnemonic() - -console.log(mnemonic.words) // prints mnemonic phrase -console.log(mnemonic.keys.private) // prints private key -console.log(mnemonic.keys.public) // prints public key - -const text = 'Hello, World!' -const cell = new Builder() - .storeString(text) - .cell() - -const boc = BOC.toBytesStandard(cell) -const result = BOC.fromStandard(boc) - .parse() - .loadString() - -console.log(text === result) // true -``` - -## Features and status - -| Feature | Status | -|---------------------------------------------|-------- | -| BOC ordinary/exotic (de)serialization | ✅ | -| Builder, Cell, Slice | ✅ | -| Hashmap (dictionary) (de)serialization | ✅ | -| HashmapE (dictionary) (de)serialization | ✅ | -| Mnemonic/keypair BIP39 standard | ✅ | -| Mnemonic/keypair TON standard | ✅ | -| Coins (class for TON, JETTON, e.t.c.) | ✅ | -| Address (class for TON address) | ✅ | -| Message layouts (such as MessageX e.t.c.) | ✅ | -| Contracts (abstract TON contract class) | ✅ | -| ~100% tests coverage | ❌ | - -## Donations -You can support library author by sending any amount of TON to address below -``` -UQCcJpog-XAzY7tK6uqCd6QrEBlgocPXdXgIG3ev1Dxg5dl2 -``` - -## License - -MIT License +# Deprecation notice +>⚠️ Repo was moved to [tonkite](https://github.com/tonkite/ton3-core) organization.