From b9c12099d2e42bd47a9386d986fbcc9fffe3f924 Mon Sep 17 00:00:00 2001
From: zuies <zurabichkhikvadze66@gmail.com>
Date: Mon, 11 Dec 2023 15:26:58 +0300
Subject: [PATCH 1/2] update readme file

---
 README.md | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 71 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 31a09161..569db95a 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,74 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/35792fb5b2e30c99022c/maintainability)](https://codeclimate.com/github/RnDAO/tc-uiComm/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/35792fb5b2e30c99022c/test_coverage)](https://codeclimate.com/github/RnDAO/tc-uiComm/test_coverage)
 
-### Togethercrew application
+## Overview
+
+Welcome to the `rndao` project! This repository contains a Next.js application with a rich set of features and dependencies geared towards building a robust and scalable web application.
+
+## Getting Started
+
+### Prerequisites
+
+Before you begin, ensure you have the following installed:
+
+- Node.js (version 18.11.9 or higher)
+- npm (comes with Node.js)
+
+### Installation
+
+1.  Clone the repository to your local machine.
+2.  Navigate to the project directory.
+3.  Run `npm install` to install all the dependencies listed in `package.json`.
+
+### Available Scripts
+
+In the project directory, you can run:
+
+- `npm run dev`\
+  Starts the development server.
+
+- `npm run build`\
+  Builds the app for production.
+
+- `npm run start`\
+  Runs the built app in production mode.
+
+- `npm run lint`\
+  Runs ESLint to catch linting errors.
+
+- `npm run test`\
+  Launches the test runner.
+
+- `npm run coverage`\
+  Generates test coverage.
+
+- `npm run export`\
+  Exports a static version of the app.
+
+## Dependencies
+
+The project uses a variety of dependencies for different purposes:
+
+- React and Next.js: For building the user interface and server-side rendering.
+- TypeScript: For adding type safety to the codebase.
+- ESLint and Prettier: For code formatting and linting.
+- Jest: For running tests.
+- Material-UI and Emotion: For UI components and styling.
+- Highcharts: For data visualization.
+- Axios: For making HTTP requests.
+- Sentry: For error tracking and monitoring.
+- Zustand: For state management.
+
+And many others that enhance the functionality and performance of the application.
+
+## Contributing
+
+Contributions are welcome! Please read our contributing guidelines before submitting pull requests.
+
+## License
+
+This project is licensed under the [MIT License](https://chat.openai.com/c/LICENSE).
+
+---
+
+For more details, refer to the project's documentation or contact the maintainers.

From f6419c8ffaa79f98889aba7d221c1c514714e53a Mon Sep 17 00:00:00 2001
From: zuies <zurabichkhikvadze66@gmail.com>
Date: Mon, 11 Dec 2023 15:33:00 +0300
Subject: [PATCH 2/2] update readme

---
 README.md | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 569db95a..d3b57d6c 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 
 ## Overview
 
-Welcome to the `rndao` project! This repository contains a Next.js application with a rich set of features and dependencies geared towards building a robust and scalable web application.
+Welcome to the `Togethercrew` project! This repository contains a Next.js application with a rich set of features and dependencies geared towards building a robust and scalable web application.
 
 ## Getting Started
 
@@ -49,15 +49,15 @@ In the project directory, you can run:
 
 The project uses a variety of dependencies for different purposes:
 
-- React and Next.js: For building the user interface and server-side rendering.
-- TypeScript: For adding type safety to the codebase.
-- ESLint and Prettier: For code formatting and linting.
-- Jest: For running tests.
-- Material-UI and Emotion: For UI components and styling.
-- Highcharts: For data visualization.
-- Axios: For making HTTP requests.
-- Sentry: For error tracking and monitoring.
-- Zustand: For state management.
+- **[React](https://reactjs.org/) and [Next.js](https://nextjs.org/)**: For building the user interface and server-side rendering.
+- **[TypeScript](https://www.typescriptlang.org/)**: For adding type safety to the codebase.
+- **[ESLint](https://eslint.org/) and [Prettier](https://prettier.io/)**: For code formatting and linting.
+- **[Jest](https://jestjs.io/)**: For running tests.
+- **[Material-UI](https://mui.com/) and [Emotion](https://emotion.sh/)**: For UI components and styling.
+- **[Highcharts](https://www.highcharts.com/)**: For data visualization.
+- **[Axios](https://axios-http.com/)**: For making HTTP requests.
+- **[Sentry](https://sentry.io/welcome/)**: For error tracking and monitoring.
+- **[Zustand](https://github.com/pmndrs/zustand)**: For state management.
 
 And many others that enhance the functionality and performance of the application.