diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..92372d23 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,57 @@ + +# KEthereum - Kotlin Ethereum Library Documentation + +## Overview +KEthereum is a comprehensive Kotlin library for interacting with the Ethereum blockchain. It provides tools for developers to build applications that connect to Ethereum nodes, manage accounts, and handle transactions efficiently. + +--- + +## Key Features + +- **JSON-RPC Client**: Connects to Ethereum nodes using the JSON-RPC protocol +- **Account Management**: Securely generate, store, and manage Ethereum accounts +- **Transaction Handling**: Create, sign, and broadcast transactions +- **Smart Contract Interaction**: Deploy and interact with smart contracts +- **Cross-platform Support**: Works on Android, JVM, and other Kotlin platforms +- **Event Monitoring**: Track blockchain events and state changes + +--- + +## Module Overview + +### Core Module +- **JSON-RPC Client**: Facilitates communication with Ethereum nodes +- **Account Management**: Handles key pairs and wallet operations +- **Transaction Builder**: Constructs and signs transactions +- **Blockchain Monitoring**: Tracks blocks, transactions, and logs + +### Extensions +- **Ethereum Wallet**: Integration with hardware wallets and secure storage +- **Smart Contract Compiler**: Compiles Solidity contracts to bytecode +- **Monitoring Tools**: Provides utilities for monitoring blockchain activity + +--- + +## Community Support + +- **GitHub Repository**: [https://github.com/komputing/KEthereum](https://github.com/komputing/KEthereum) +- **Documentation**: [https://docs.komputing.io/KEthereum](https://docs.komputing.io/KEthereum) +- **Discussion Forum**: [https://forum.komputing.io](https://forum.komputing.io) +- **Slack Channel**: Join the `#kethereum` channel on Komputing Slack + +--- + +## Getting Started + +To integrate KEthereum into your project, add the following dependency to your `build.gradle.kts` or `build.gradle`: + +```kotlin +implementation("io.komputing:kethereum:1.0.0") +``` + +For more detailed information, please refer to the [KEthereum Documentation](https://docs.komputing.io/KEthereum). + +--- + +## License +KEthereum is licensed under the MIT License. See the [LICENSE](https://github.com/komputing/KEthereum/blob/main/LICENSE) file for more details.