Is your feature request related to a problem? Please describe.
For now, SDK is lack of documentations, a good documentation is necessary for newcomers to understand how to use it.
Describe the solution you'd like
Write documentations in RADME.md with following a standard style such as standard-readme
Here are the parts we want to add or modify:
An introduction part for describing what SDK does and what it can do.
An example part for describing examples we have and developer can take them as references.
An extension part for describing what applications are written in this SDK.
An API part for describing What SDK has:
wallet part, what AElf.wallet has and what they can do
chain methods which communicate with AElf chain, list and describe them
How to get a contract and call contract method, what's the different between contractMethod.call() and contractMethod()
Some useful utils provided by the SDK
All docs are need to be well structured and indexed.
The other parts which are needed for an open-source project, take other open-source projects as references.
atom-yang
commented
4 years ago
Is your feature request related to a problem? Please describe. For now, SDK is lack of documentations, a good documentation is necessary for newcomers to understand how to use it.
Describe the solution you'd like Write documentations in
RADME.mdwith following a standard style such as standard-readme Here are the parts we want to add or modify:walletpart, whatAElf.wallethas and what they can doAElf chain, list and describe themcontractMethod.call()andcontractMethod()utilsprovided by the SDK