search

komputing / KEthereum

Kotlin library for Ethereum
MIT License
350 stars 73 forks source link

Documentation #9

Open yadaniyil opened 7 years ago

issueth[bot] commented 7 years ago

This issue now has a bounty-address via issuETH.

Your bounty-address is eea3dd718ae693302d58540d6f40ccec1c076ba1
Watch on rinkeby
Watch on main

ligi commented 7 years ago

Not yet - will care for documentation after 1.0 - currently this is too much in flux for that. But feel free to ask what you need to know. I think as it is broken down in small modules it should be easy to dig in. PRs for documentation are highly welcome - I am better at writing code than text for humans ..-)

issueth[bot] commented 7 years ago

Token-transfer transaction on rinkeby with value 7.1WALL

hshar7 commented 6 years ago

No documentation until a stable release is fine but not even a simple get started guide in the readme? Also any idea when 1.0 is happening?

ligi commented 6 years ago

thanks for the question. I recently started with one module

https://github.com/walleth/kethereum/tree/master/erc55 - see the README there

Also exploring https://github.com/JetBrains/kotlin-web-demo currently as I think this might be a great way to document - unfortunately facing some problems currently - some get solved https://github.com/JetBrains/kotlin-web-demo/pull/55 - one still outstanding. Once this works I want to make some examples this way. I want to get more usable for kotlinkonf as I will do a talk by then.

hshar7 commented 6 years ago

Please add something like that to the RPC module. It's the entry point for most people and it's where I am getting started with.

araa47 commented 5 years ago

@ligi what's the current status with this project? Are we gonna get v1 docs anytime soon?

ligi commented 5 years ago

Status or this project is good - it is used by several other projects and in active development. Unfortunately the status for the docs is not that good - I was putting out a gitcoin bounty for it but it did not gain traction. Contributions in this direction are welcome.

ligi commented 4 years ago

There is now a little bit more documentation - started with an overview over the modules in the README: https://github.com/komputing/KEthereum/blob/master/README.md and will then try to add documentation for the modules step by step.