From 85f8e26a38941504a72849c4dd198de3635acec9 Mon Sep 17 00:00:00 2001
From: Zig Blathazar <42387185+ZigBalthazar@users.noreply.github.com>
Date: Mon, 1 Apr 2024 02:21:38 +0330
Subject: [PATCH] feat: add readme (#7)

---
 README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 64 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 9ac3dad..723f0cb 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,65 @@
-# Wrapped Tokens
+# Wrapped PAC (WPAC) Token
 
-This monorepo contains wrapped tokens of teleport protocol contracts.
+Welcome to the repository for Wrapped PAC (WPAC) token. WPAC is a wrapped token (ERC20) compatible with all EVM blockchains, providing interoperability for PAC tokens across different networks.
+
+## Project Overview
+
+WPAC tokens are wrapped tokens of the Teleport Protocol contracts. The token contract is implemented in Solidity and follows the OpenZeppelin Contracts upgradeable pattern. It allows users to bridge PAC tokens from one blockchain to another by locking the tokens in the contract and minting WPAC tokens on the destination chain.
+
+## Getting Started
+
+To get started with the project, follow these steps:
+
+1. Clone this repository to your local machine:
+
+   ```bash
+   git clone <repository_url>
+   ```
+
+2. Navigate to the project directory:
+
+   ```bash
+   cd TeleWrapped
+   ```
+
+3. Install dependencies:
+
+   ```bash
+   npm install
+   ```
+
+## Available Scripts
+
+In the project directory, you can run the following scripts:
+
+- `npm run node`: Starts a local Hardhat node for testing.
+- `npm run compile`: Compiles the Solidity contracts.
+- `npm run clean`: Cleans up artifacts, cache, coverage, and typechain files.
+- `npm run lint:sol`: Lints the Solidity contracts using Solhint.
+- `npm run lint:ts`: Lints the TypeScript files using ESLint.
+- `npm run test`: Runs the Hardhat tests.
+- `npm run typechain`: Generates TypeScript bindings for the Solidity contracts.
+
+## Contract Overview
+
+The main contract file is `WrappedPAC.sol` which implements the ERC20 interface. It also integrates functionalities for bridging PAC tokens from one blockchain to another. The contract is upgradeable and follows the Ownable and Pausable patterns for security and control.
+
+## Project Structure
+
+The main project files and directories are structured as follows:
+
+- `contracts/`: Contains Solidity contracts.
+- `test/`: Contains test scripts for the contracts.
+- `scripts/`: Contains scripts for deployment and testing.
+- `artifacts/`: Contains contract artifacts generated by Hardhat.
+- `package.json`: Configuration file for Node.js dependencies and scripts.
+- `hardhat.config.js`: Configuration file for Hardhat.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+
+---
+
+Thank you for using Wrapped PAC (WPAC) Token! If you have any questions or issues, please don't hesitate to contact us.
+[Dezh Technologies](https://dezh.tech)