UPDATE: README.md

ADD: ci workflow with pylint

Author: BaggerFast

.github/workflows/main.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+      - develop
+
+jobs:
+  code_analyzer:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install pylint
+      - name: Pylint
+        run: pylint pacman

README.md

@@ -1,6 +1,43 @@
-# Pycman
-
+# Pacman
+[![ci-status](https://github.com/BaggerFast/Pacman/workflows/CI/badge.svg)](https://github.com/BaggerFast/Pacman/actions/)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/BaggerFast/Pacman/main.svg)](https://results.pre-commit.ci/latest/github/BaggerFast/Pacman/main)
 [![CodeFactor](https://www.codefactor.io/repository/github/baggerfast/pacman/badge)](https://www.codefactor.io/repository/github/baggerfast/pacman)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+
+Pacman is a simple game written on Pygame. The game was created as a learning project to explore
+the possibilities of Pygame and develop game applications.
+
+## 📺 Preview
+- Watch on [YouTube](https://youtu.be/2sRJK_TwXmk)
+
+## 💻 Tech Stack
+- [Python 3.10](https://www.python.org/)
+- [Pygame](https://www.pygame.org/news)
+- **Tools:**
+  - [Black](https://github.com/psf/black)
+  - [Isort](https://github.com/PyCQA/isort)
+  - [PyLint](https://github.com/pylint-dev/pylint)
+  - [CodeFactor](https://www.codefactor.io/)
+    
+## 👀 Look at this
+- [Text](pacman/objects/text.py)
+- [Button + controller](pacman/objects/buttons)
+- [Sounds + controller](pacman/sound)
+- [Scenes + SceneManager](pacman/scenes)
+- [Animators + SpriteSheets](pacman/animator)
+- [Saves - json serialize/deserialize](pacman/storage)
+
+## 💾 Cheat codes
+- In Game
+  - **god** - victory scene
+  - **kill** - lose scene
+  - **aezakmi** - give 1 extra live
+- In Menu
+  - **pycman** - unlock all skins and levels
+
+## 🎧 Set custom sounds in FUN MODE
+![img.png](assets/fun_mode.png)
 
- <img alt="Ghost Board" width="394" height="212" src="assets/ghost_board.png" />
+## 🚑 Support 
+Please click the `star` button, if this game was helpful to you.