Update instructions

Author: pH-7

LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+*Copyright (c) 2025 [Pierre-Henry Soria](https://ph7.me)*
+
+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

@@ -5,22 +5,71 @@
 - Model trained on breast cancer dataset
 - REST API with FastAPI - real-time requests
 - Docker support
+- Environment variable configuration
+- Citable research-ready API
+- MIT Licensed
+
+## 📂 Project Structure
+
+```plaintext
+.
+├── app/                # FastAPI application
+├── train/              # Training scripts
+├── assets/images/      # Images, diagrams
+├── requirements.txt    # Python dependencies
+├── Dockerfile
+├── .env.dist           # Sample environment variables
+├── LICENSE.md
+└── README.md
+```
 
 ## 🔋 Run Locally
 
+1. Clone the repository:
+```bash
+git clone https://github.com/your-username/Python_GML_MLPipeline.git
+cd Python_GML_MLPipeline
+```
+
+2. Create and activate a virtual environment:
+```bash
+python -m venv venv
+source venv/bin/activate
+```
+
+3. Install dependencies:
+```bash
+pip install -r requirements.txt
+```
+
+4. Copy `.env.dist` to `.env` and configure your environment variables:
+```env
+PORT=8000
+MODEL_PATH=train/model.pkl
+```
+
+5. Train the model:
 ```bash
 cd train/
 python train_model.py
-
 cd ..
-uvicorn app.main:app --reload
+```
+
+6. Start the server:
+```bash
+uvicorn app.main:app --reload --port $PORT
 ```
 
 ## 🐟 Docker
 
+1. Build the Docker image:
 ```bash
 docker build -t ml-api .
-docker run -p 8000:8000 ml-api
+```
+
+2. Run the container:
+```bash
+docker run --env-file .env -p 8000:8000 ml-api
 ```
 
 Visit `http://127.0.0.1:8000/docs` for Swagger UI.
@@ -33,3 +82,7 @@ Visit `http://127.0.0.1:8000/docs` for Swagger UI.
 Made with ❤️ by **[Pierre-Henry Soria](https://pierrehenry.be)**. A super passionate & enthusiastic Problem-Solver / Senior Software Engineer. Also a true cheese 🧀, ristretto ☕️, and dark chocolate lover! 😋
 
 [![@phenrysay](https://img.shields.io/badge/x-000000?style=for-the-badge&logo=x)](https://x.com/phenrysay "Follow Me on X")  [![pH-7](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/pH-7 "My GitHub")  [![YouTube Video](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://youtu.be/cWBuZ4DXGK4 "YouTube SucceedAI Video")  [![BlueSky](https://img.shields.io/badge/BlueSky-00A8E8?style=for-the-badge&logo=bluesky&logoColor=white)](https://bsky.app/profile/ph7s.bsky.social "Follow Me on BlueSky")
+
+## 📄 License
+
+Distributed under the [MIT License](LICENSE.md) 🎉 Happy hacking! 🤠