From f68cc9be73d9721c5be42420289c6fd4b5a0c6be Mon Sep 17 00:00:00 2001
From: Felipe Muner <felipe.muner@gmail.com>
Date: Tue, 12 Nov 2024 06:36:27 +0700
Subject: [PATCH] update: readme

---
 README.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fb2c0fc..dceb6d7 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,34 @@
-# cryptozombies
\ No newline at end of file
+# CryptoZombies
+
+## Overview
+
+CryptoZombies is a blockchain-based project that utilizes **Solidity** and **TypeScript**. This project is structured as a learning or interactive platform where users can learn how to code smart contracts for blockchain applications, similar to the popular CryptoZombies tutorial.
+
+## Features
+
+1. **Smart Contracts**: Developed using Solidity, these contracts demonstrate core blockchain programming concepts.
+2. **Testing Suite**: Includes tests written in TypeScript to verify contract functionality.
+3. **Hardhat Integration**: Utilizes Hardhat for development, testing, and deployment of contracts.
+
+## Installation
+
+1. Clone the repository:
+```bash
+   git clone https://github.com/leodutra/cryptozombies.git
+   cd cryptozombies
+   ```
+
+2. Clone the repository:
+```bash
+   npm install
+   ```
+
+3. Clone the repository:
+```bash
+   npx hardhat compile
+   ```
+
+4. Run tests:
+```bash
+   npx hardhat test
+   ```
\ No newline at end of file