From 9d8fe823c04fac954a7eebe9d6257a10ca08ed89 Mon Sep 17 00:00:00 2001
From: DaveVodrazka <dave.vodrazka@gmail.com>
Date: Fri, 21 Jun 2024 14:34:10 +0200
Subject: [PATCH] chore: update README

---
 README.md | 65 +++++++++++++++++++++++++++++++++----------------------
 1 file changed, 39 insertions(+), 26 deletions(-)

diff --git a/README.md b/README.md
index 290014f7..1c8c7f14 100644
--- a/README.md
+++ b/README.md
@@ -1,46 +1,59 @@
-# Carmine FE App
+# Carmine Finance Options AMM App
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+[![CI/CD Pipeline](https://github.com/CarmineOptions/fe-app/actions/workflows/release.yaml/badge.svg)](https://github.com/CarmineOptions/fe-app/actions/workflows/release.yaml)
 
-## Available Scripts
+Frontend application allowing users to interact with the decentralized protocol [Carmine Options AMM](https://starkscan.co/contract/0x047472e6755afc57ada9550b6a3ac93129cc4b5f98f51c73e0644d129fd208d9#overview).
 
-In the project directory, you can run:
+## Table of Contents
 
-### `npm start`
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+## Introduction
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+Carmine Finance Options AMM App is a React-based frontend application that facilitates user interaction with the Carmine Options AMM decentralized protocol. It provides a user-friendly interface to manage and trade options in a decentralized manner.
 
-### `npm test`
+## Installation
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+To run this project locally, follow these steps:
 
-### `npm run build`
+1. **Clone the repository:**
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+   ```bash
+   git clone https://github.com/CarmineOptions/fe-app.git
+   ```
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
+2. **Navigate to the project directory:**
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+   ```bash
+   cd fe-app
+   ```
 
-### `npm run eject`
+3. **Install dependencies:**
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+   ```bash
+   npm install
+   ```
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+4. **Run in development mode:**
+   ```bash
+   npm start
+   ```
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+## Usage
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+After starting the application, open your browser and navigate to `http://localhost:3000`. You will be able to interact with the Carmine Options AMM protocol through the user interface.
 
-## Learn More
+## Contributing
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+We welcome contributions to the Carmine Finance Options AMM App. To contribute:
 
-To learn React, check out the [React documentation](https://reactjs.org/).
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-branch`).
+3. Commit your changes (`git commit -m 'Add some feature'`).
+4. Push to the branch (`git push origin feature-branch`).
+5. Open a Pull Request.
+
+Please ensure your code adheres to our coding standards and passes all tests.