Update README.md

README.md

@@ -1,7 +1,78 @@
-# Tauri + React + Typescript
+# HMSoft
 
-This template should help get you started developing with Tauri, React and Typescript in Vite.
+**HMSoft** is an open-source Hotel Management Software built using [Tauri](https://tauri.app/), [Rust](https://www.rust-lang.org/), and [TypeScript](https://www.typescriptlang.org/). This project aims to provide a lightweight, fast, and secure hotel management solution for small to medium-sized businesses.
 
-## Recommended IDE Setup
+## Features
 
-- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
+- **Room Management**: Manage room bookings, availability, and pricing.
+- **Customer Management**: Keep track of guest details and reservation history.
+- **Billing and Invoicing**: Generate invoices and manage payment records.
+- **Staff Management**: Manage employee roles, shifts, and tasks.
+- **Reports and Analytics**: View key metrics and generate reports on occupancy, revenue, and performance.
+- **Cross-Platform**: Available for Windows, macOS, and Linux thanks to Tauri.
+
+## Tech Stack
+
+- **Tauri**: For building cross-platform desktop applications.
+- **Rust**: Ensures high performance and memory safety.
+- **TypeScript**: Provides type safety and modern JavaScript features.
+
+## Installation
+
+### Executable
+
+#### Windows
+
+#### Linux
+
+#### Mac
+
+### Local
+
+#### Prerequisites
+
+- [Rust](https://www.rust-lang.org/tools/install)
+- [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/get-npm)
+- [Tauri prerequisites](https://tauri.app/v1/guides/getting-started/prerequisites)
+
+#### Clone the Repository
+
+```bash
+git clone https://github.com/adeirjunior/HMSoft.git
+```
+
+```bash
+cd HMSoft
+```
+
+```bash
+npm install
+```
+
+```bash
+npm run tauri build
+```
+
+```bash
+npm run tauri dev
+```
+
+## Contributing
+
+Contributions are welcome! To get started:
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-branch`).
+3. Commit your changes (`git commit -am 'Add new feature'`).
+4. Push to the branch (`git push origin feature-branch`).
+5. Open a pull request.
+
+Please make sure your code follows the project's style guidelines and passes all tests.
+
+## License
+
+HMSoft is open-source software licensed under the [MIT License](LICENSE).
+
+---
+
+### Made with ❤️ by [Adeir Junior](https://adeir.me)