update readme

Author: TulshiDas39

README.md

@@ -1,35 +1,130 @@
-# LithiumGit
+# 🚀 LithiumGit
 
-**Download and install latest version from [releases](https://github.com/TulshiDas39/LithiumGit/releases)..**
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/tulshidas39/lithiumgit)  
 
-This is a cross platform Git GUI application.
 
-# Architecture
+**LithiumGit** is an advanced desktop application designed to simplify and supercharge your Git workflow. Whether you're a seasoned Git user or just getting started, Lithium Git Client provides you with a seamless, feature-rich, and customizable experience while managing your repositories.
 
-common_library: This is a local npm package which is used in both backend and ui. Functions,classes,types etc needed both in backend and ui are exported from here.
+---
 
-ui: This is a react app built with create-react-app template. This is the application ui.
+## ✨ Key Features
 
-# Steps to run
-
-build and install the common library:  
--navigate to common_library folder and run "npm run build"  
-  
-run the ui:  
--navigate to ui folder and run "npm start"  
+- **🌟 User-Friendly Interface**: Manage your repositories with ease using our intuitive GUI. No more memorizing complex Git commands – it's all here at your fingertips!
 
-run the backend:    
--open ./src/config.ts file  
--ensure static readonly ENV:'development'|'production' = 'development';      
--npm start  
+- **⚙️ Advanced Git Operations**: Perform even the most complex Git tasks effortlessly. From branching to cherry-picking, we've got you covered.
+
+- **📈 Interactive Graph View**: Visualize the history and structure of your repositories with a sophisticated graph view.  
+  ![Graph View](https://lithiumgit.github.io/_next/static/media/graph.e4449400.png)
+
+- **💻 Cross-Platform Support**: Lithium Git Client works everywhere you code: Windows, macOS, and Linux.  
+
+- **⚡ Customizable Workflows**: Tailor the application to fit your unique development needs. Customize shortcuts, automate repetitive tasks, and more!
+
+---
+
+## 🛠️ Installation
+
+Follow these steps to install LithiumGit Client on your machine:
+
+### Windows
+1. Download the latest release for Windows from the [Releases Page](https://github.com/tulshidas39/lithiumgit/releases).
+2. Run the installer and follow the on-screen instructions.
+3. Launch **LithiumGit** and start exploring Git like never before!
+
+### macOS
+1. Download the `.dmg` file from the [Releases Page](https://github.com/tulshidas39/lithiumgit/releases).
+2. Open the `.dmg`, drag the app into your `Applications` folder, and you're ready to go!
+
+### Linux
+1. Download the appropriate `.AppImage` or `.deb` file for your distribution.  
+   For AppImage:
+   ```bash
+   chmod +x [LithiumGit].AppImage
+   ./[LithiumGit].AppImage
+   ```
+   For Debian/Ubuntu:
+   ```bash
+   sudo dpkg -i [lithiumgit].deb
+   ```
+2. Run and enjoy a powerful Git experience.
+
+---
+
+## 🚦 How to Use
+
+1. Open **LithiumGit** and select a repository you'd like to manage or clone a repository from any Git URL.
+2. Perform various Git operations such as:
+   - View commit history through the **Interactive Graph View**.
+   - Stage/Unstage changes with a few clicks.
+   - Branch creation and merging made simple.
+3. Customize your workflows through settings and shortcuts for efficiency.
+   
+_Enjoy lightning-fast Git operations from one central tool!_
+
+---
+
+
+## 🤝 Contributing
+
+Contributions are more than welcome! Please feel free to:
+
+- Submit bug reports or feature requests on [GitHub Issues](https://github.com/tulshidas39/lithiumgit/issues).
+- Fork the repository, make your changes, and open a Pull Request to get your contributions merged.
+
+### Local Development Setup
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/tulshidas39/lithiumgit.git
+   cd lithiumgit
+   ```
+2. Install dependencies:
+   ```bash
+   npm install  # Or yarn install
+   ```
+3. Start the main process:
+   ```bash
+   npm start
+   ```
+4. Navigate to ui:
+   ```bash
+   cd ui
+   ```
+5. Install dependencies of ui:
+   ```bash
+   npm install  # Or yarn install
+   ```
+6. Start the renderer process:
+   ```bash
+   npm start
+   ```
+
+---
+
+## 📜 License
+
+This project is licensed under the **MIT License**. See the [LICENSE](./LICENSE) file for full details.
+
+---
+
+## 🌐 Website
+
+For detailed usage instructions, and resources, visit our  website:  
+👉 **[Lithium Git Client Documentation & Guide](https://lithiumgit.github.io/)**  
+
+---
+
+## 📬 Questions or Feedback?
+
+If you have any questions, feedback, or feature requests, feel free to reach out to:
+
+- **GitHub Issues**: [GitHub Issues](https://github.com/tulshidas39/lithiumgit/issues)
+
+We welcome users and contributors alike. Let's build the best Git client experience together! 🚀  
+
+---
 
-# Steps to create distribution
--navigate to common_library folder and run "npm run build"  
--open ./src/config.ts file  
--ensure static readonly ENV:'development'|'production' = 'production';  
--delete ./dist/db and ./dist/log folders if exist.  
--run "npm run package" in root directory.  
+## 🌟 Support the Project
 
-## License
+If you find **Lithium Git Client** helpful, please consider giving this repository a ⭐ on GitHub. It helps others discover the project!
 
-[MIT](LICENSE)
+---

package.json

@@ -1,6 +1,6 @@
 {
   "name": "lithiumgit",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "A git gui application",
   "scripts": {
     "build": "tsc && npm run copy_src_assets",

src/config.ts

@@ -1,6 +1,6 @@
 import { Env } from "./types";
 
 export class Config{
-    static readonly env:Env=Env.DEVELOPMENT;
+    static readonly env:Env=Env.PRODUCTION;
     static readonly UI_PORT = 57631;
 }