Update README.md

README.md

@@ -1,27 +1,53 @@
-# LmStudioPlayground
+# LMStudio Api Angular Playground
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.3.7.
+This project is built with Angular 17 and Angular Material, enabling interaction with large language models (LLMs) loaded in the LM Studio application. The application allows users to display the various loaded models, change the internal prompt, and update the API URL for LM Studio.
 
-## Development server
+## Features
 
-Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
+- **LLM Interaction:** Send queries and receive responses from large language models loaded in LM Studio.
+- **Model Visualization:** Display the various language models currently loaded in memory.
+- **Dynamic Configuration:** Change the internal prompt and the LM Studio API URL from the user interface.
 
-## Code scaffolding
+## Requirements
 
-Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+- **Node.js** (version 18 or higher)
+- **Angular CLI**
+- **LM Studio**
 
-## Build
+## Installation
 
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
+1. Clone this repository to your local machine.
+    ```bash
+    git clone https://github.com/marcguillemdev/LMStudio-API-Angular-Playground
+    ```
+2. Navigate to the project directory.
+    ```bash
+    cd LMStudio-API-Angular-Playground
+    ```
+3. Install the project dependencies.
+    ```bash
+    npm install
+    ```
 
-## Running unit tests
+## Usage
 
-Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+1. Ensure that **LM Studio** is running and accessible at the configured URL.
+2. Start the Angular application.
+    ```bash
+    ng serve
+    ```
+3. Open your web browser and navigate to `http://localhost:4200` to view the application.
 
-## Running end-to-end tests
+## Configuration
 
-Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
+You can change the **LM Studio API URL** and the **internal prompt** through the configuration dialog in the application. Below are screenshots of the chat and the configuration dialog for better understanding:
 
-## Further help
+### Chat Screenshot
+![Chat Screenshot](https://github.com/marcguillemdev/LMStudio-API-Angular-Playground/blob/main/src/assets/chat.png?raw=true)
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+### Configuration Dialog Screenshot
+![Config Dialog Screenshot](https://github.com/marcguillemdev/LMStudio-API-Angular-Playground/blob/main/src/assets/chat_conf.png?raw=true)
+
+## License
+
+This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for more details.