From 1ec84c1512ef50596027a3ccd042477d9aacd66c Mon Sep 17 00:00:00 2001 From: Yongfeng LI Date: Mon, 21 May 2018 10:45:41 +0800 Subject: [PATCH] add links to readme --- README.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6f31cb7..fd8ff46 100644 --- a/README.md +++ b/README.md @@ -2,38 +2,49 @@ ## Terminology -### Keys +### [Keys](https://bytom-node-sdk.github.io/global.html#Key__anchor) Cryptographic keys are the primary authorization mechanism on a blockchain. To create accounts or assets, xpub of keys are required. With this sdk, we can -`create/delete/list/resetPassword` the key. Please check the api doc if you want +`create/delete/list/resetPassword` the key. Please check the +[API doc](https://bytom-node-sdk.github.io/module-KeysApi.html) if you want to operate with keys. -### Account +### [Account](https://bytom-node-sdk.github.io/global.html#Account__anchor) An account is an object in Bytom that tracks ownership of assets on a blockchain. -It's defined under one Bytom node created with one or serveral keys. +It's defined under one Bytom node created with one or serveral keys. -### Asset +[Related API](https://bytom-node-sdk.github.io/module-AccountsApi.html) + +### [Asset](https://bytom-node-sdk.github.io/global.html#Asset__anchor) An asset is a type of value that can be issued on a blockchain. All units of a given asset are fungible. Units of an asset can be transacted directly between parties without the involvement of the issuer. -### Transaction +[Related API](https://bytom-node-sdk.github.io/module-AssetsApi.html) + +### [Transaction](https://bytom-node-sdk.github.io/global.html#Transaction__anchor) Blockchain is chain of blocks, while block consists of numbers of transactions. -### Unspent Output(UTXO) +[Related API](https://bytom-node-sdk.github.io/module-TransactionsApi.html) + +### [Unspent Output(UTXO)](https://bytom-node-sdk.github.io/global.html#UnspentOutput__anchor) Bytom is UTXO based blockchain. One transaction spend some UTXOs, and produces new UTXOs. -### Balance +[Related API](https://bytom-node-sdk.github.io/module-UnspentOutputsApi.html) + +### [Balance](https://bytom-node-sdk.github.io/global.html#Balance__anchor) Any balance on the blockchain is simply a summation of UTXOs. In one bytomd, balance means summation of UTXOs of one account. +[Related API](https://bytom-node-sdk.github.io/module-BalancesApi.html) + ## Usage ### In your code -- 2.11.0