Skip to content

Commit 0386d65

Browse files
author
Fabrice Bascoulergue
committed
Add base readme and documentation
1 parent 8ac03a2 commit 0386d65

File tree

2 files changed

+42
-1
lines changed

2 files changed

+42
-1
lines changed

DOCUMENTATION.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Javascript SDK Documentation

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,41 @@
1-
# sdk-javascript
1+
# Sandblock Chain - Javascript SDK
2+
3+
This Javascript SDK enables browsers and NodeJS clients to interact with the Sandblock Chain.
4+
5+
## SDK Features
6+
7+
This SDK basically provides an easy access to all the available Sandblock Chain RPCs as well as the payload generation and the cryptographic features to properly consume those RPCs.
8+
9+
**Most comonly used features:**
10+
11+
- Core cryptographic tools and functions
12+
- Client service:
13+
- Connection to a blockchain node (http and socket mode)
14+
- Transaction broadcast
15+
- Blockchain RPCs
16+
- Accounts and wallets:
17+
- Accounts seed and encrypted mnemonic generation
18+
- Unlock accounts from private keys, keystore and mnemonic
19+
- Wallet balance
20+
- Transactions
21+
- Payload generation
22+
- Signature
23+
24+
## Documentation
25+
26+
The SDK code should be documented enough for developers to explore it and use it easily. Therefore the documentation might not cover all the capabilities of the SDK. Feel free to contribute if you wish to improve the code documentation and/or the provided samples.
27+
28+
The [Documentation](./DOCUMENTATION.md) contains:
29+
- Installation instructions
30+
- Basic usage
31+
- Code samples
32+
33+
## Contributing
34+
35+
Contributions are most welcome.
36+
37+
Please test your changes with a local client and add unit tests coverage for your code before submission.
38+
39+
## Special notes
40+
41+
Thanks to the Binance team for their work on the Binance Javascript SDK which inspired this project structure and development.

0 commit comments

Comments
 (0)