docs: update README.md

Author: The-Best-Codes

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 BestCodes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -2,15 +2,73 @@
 
 [![CodeQuill](https://img.shields.io/badge/CodeQuill-Code%20Editor%20and%20Storage-blue)](https://github.com/codingwithkid/codequill)
 
-CodeQuill is a free and easy way to organize, store, edit, and share code on your device. It is a web-based code editor that allows you to create and manage code snippets.
+[![Logo](app/favicon.ico)](https://github.com/The-Best-Codes/codequill)
 
-## How to Use
+CodeQuill is a web-based code editor designed to offer a free, easy, and efficient way to organize, store, edit, and share code snippets directly from your device. Whether you're working on personal projects or simply storing snippets for future reference, CodeQuill provides a seamless experience for managing your code.
 
-To start using CodeQuill, follow these steps:
+## Features
 
-1. Download the project from GitHub
-2. Run `node scripts/init-db.js` in the project directory to initialize the database
-3. Run `npm run dev` to start the development server
-4. Open `http://localhost:3000` in your web browser to access the CodeQuill interface
+- **Syntax Highlighting:** Enjoy coding with syntax highlighting that supports multiple languages.
+- **Code Storage:** Save your snippets in the a local database for easy access anywhere on your network.
+- **Share**: Share your code snippets with other devices on your network to easily transfer codes.
+- **Comfortable Interface:** The editor is designed to be as intuitive and familiar as possible. The experience should remind you of working in VS Code.
 
-Alternatively, you can run `npm run build && npm start` to build and start the production server.
+## Getting Started
+
+### Prerequisites
+
+- Node.js installed on your machine
+- A modern web browser
+
+### Installation
+
+1. Clone the repository to your local machine:
+
+   ```bash
+   git clone https://github.com/The-Best-Codes/codequill.git
+   cd codequill
+   ```
+
+2. Install the required dependencies:
+
+   ```bash
+   npm install
+   ```
+
+3. Initialize the database:
+
+   ```bash
+   node scripts/init-db.js
+   ```
+
+4. Start the development server:
+
+   ```bash
+   npm run dev
+   ```
+
+5. Access the CodeQuill interface by opening `http://localhost:3000` in your web browser.
+
+### Building for Production
+
+To deploy CodeQuill for production use:
+
+```bash
+npm run build && npm start
+```
+
+This command builds the application for optimal performance and starts the production server.
+
+## Contributing
+
+We welcome contributions to CodeQuill! Whether you're looking to fix bugs, add new features, or improve documentation, please feel free to submit a pull request.
+
+## License
+
+CodeQuill is released under the MIT License. See the LICENSE file for more details.
+
+## Support
+
+For support or to report issues, please visit the [issues page](https://github.com/The-Best-Codes/codequill/issues).
+
+Thank you for considering CodeQuill for your coding needs!