Update README.md

mdeboute · Jan 21, 2025 · 97c854d · 97c854d
1 parent b047ab2
commit 97c854d
Showing 1 changed file with 16 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,8 @@
 # pystock
 
+[![License](https://img.shields.io/github/license/mdeboute/pystock)](./LICENSE)
+[![CI-CD](https://github.com/mdeboute/pystock/actions/workflows/CI-CD.yml/badge.svg)](https://github.com/mdeboute/pystock/actions/workflows/CI-CD.yml)
+
 A tool that helps you better invest in the stock market.
 
 ## Features
@@ -11,8 +14,19 @@ A tool that helps you better invest in the stock market.
 
 ## Installation
 
- ```bash
-pip install pystock
+The package is not yet available on PyPI. To install the package, clone the repository and generate a wheel file:
+
+```bash
+git clone https://github.com/mdeboute/pystock.git
+cd pystock
+uv sync
+uv build
+```
+
+Then, install the wheel file:
+
+```bash
+pip install dist/pystock-0.1.0-py3-none-any.whl
 ```
 
 ## Usage