diff --git a/README.md b/README.md index b2661ba..bef15ec 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,82 @@ [![Go](https://github.com/SadikSunbul/GO-BlockChain-Simulation/actions/workflows/go.yml/badge.svg)](https://github.com/SadikSunbul/GO-BlockChain-Simulation/actions/workflows/go.yml) -##### GO dilinde yazılmış bir BlockChain uygulamasıdır -##### Anlaşılması için part-1,part-2 ... gibi adım adım brench lere bölünmüştür -##### BlockChain in ana mantığını adım adım yorum satırları ile birlikte açıklandı +# GO-BlockChain-Simulation + +GO-BlockChain-Simulation is a blockchain simulation written in Go. This project is developed to understand and implement the fundamentals of blockchain technology. +*** + +## Project Structure + +The project consists of the following components: + +- **cli**: Contains necessary code for the command-line interface. +- **blockchain**: Defines the structure and operations of the blockchain. +- **wallet**: Provides operations to manage cryptocurrency wallets. +- **main.go**: Main application file of the project. +*** + +## Installation + +Clone the project to your local machine: + ++ ```bash + git clone https://github.com/SadikSunbul/GO-BlockChain-Simulation.git + cd GO-BlockChain-Simulation +*** + +## Usage + +### Creating a Blockchain + +To create a new blockchain: + + ++ ```bash + go run main.go createblockchain -address
+*** + +### Checking Balance + +To check the balance for a specific address: + ++ ```bash + go run main.go getbalance -address
+*** + +### Sending Transactions + +To send a transaction on the blockchain: + ++ ```bash + go run main.go send -from -to -amount +*** + +### Viewing the Blockchain + +To print all blocks in the blockchain: + ++ ```bash + go run main.go printchain +*** + +### Creating a New Wallet + +To create a new wallet: + ++ ```bash + go run main.go createwallet +*** + +### Creating a New Wallet + +To create a new wallet: + ++ ```bash + go run main.go createwallet +*** + +## Contributing + +If you would like to contribute, please open a pull request on [GitHub](https://github.com/SadikSunbul/GO-BlockChain-Simulation). We welcome contributions of any kind to the project. +This project follows a [Code of Conduct](CODE_OF_CONDUCT.md). Please review and adhere to it in all interactions within the project. +***