From 9b448114f87a6d9d02e089191b0fdfd2f7a439a4 Mon Sep 17 00:00:00 2001
From: u8slvn <u8slvn@gmail.com>
Date: Wed, 14 Aug 2024 17:22:35 +0200
Subject: [PATCH] docs: udpate readme

---
 README.md | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 3c1f83a..5e991a1 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,25 @@
 # 🐕 doggo
 <p align="center">
     <a href="https://github.com/u8slvn/doggo/releases"><img alt="GitHub tag (with filter)" src="https://img.shields.io/github/v/release/u8slvn/doggo"></a>
+    <img src="https://img.shields.io/badge/python-3.12-blue" alt="Pypthon version">
     <a href="https://github.com/u8slvn/doggo/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/u8slvn/doggo/ci.yml?label=CI" alt="CI"></a>
     <a href="https://coveralls.io/github/u8slvn/doggo?branch=main"><img src="https://coveralls.io/repos/github/u8slvn/doggo/badge.svg?branch=main" alt="Coverage Status"></a>
     <a href="https://app.codacy.com/gh/u8slvn/doggo/dashboard"><img src="https://img.shields.io/codacy/grade/359900931def4b2cba3552678519ce2e" alt="Code Quality"></a>
     <a href="https://github.com/u8slvn/doggo"><img src="https://img.shields.io/github/license/u8slvn/doggo" alt="Project license"></a>
 </p>
 
+## ⚙️ Run
 
-## Licenses
+**doggo** use [poetry](https://python-poetry.org/) to manage dependencies and virtual environment.
 
-* Code source under GPL-3.0 License
-* Dog sprites source from [Benvictus](https://benvictus.itch.io/pixel-dogs)
+```bash
+$ poetry install
+$ poetry run python -m doggo
+```
+
+## 📝 Licenses
+
+* Code source under [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.en.html)
+* Assets:
+  * Dog sprites in `src/doggo/assets/dogs` by [Benvictus](https://benvictus.itch.io/pixel-dogs)
+  * Landscape sprites in `src/doggo/assets/landscapes` under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)