docs: add docs and demo video

Author: linhns

README.md

@@ -6,69 +6,47 @@
 [![Commit activity](https://img.shields.io/github/commit-activity/m/linhns/pyfalldown)](https://img.shields.io/github/commit-activity/m/linhns/pyfalldown)
 [![License](https://img.shields.io/github/license/linhns/pyfalldown)](https://img.shields.io/github/license/linhns/pyfalldown)
 
-Python Falldown game
+**pyfalldown** is a platformer game built with
+[pygame](https://www.pygame.org/), inspired by the classic arcade era.
 
-- **Github repository**: <https://github.com/linhns/pyfalldown/>
-- **Documentation** <https://linhns.github.io/pyfalldown/>
+In this game, you guide a circular ball downward, navigating through platforms.
+Your objective is to collect triangles while avoiding squares. Be careful not to
+touch the top or bottom edges of the screen!
 
-## Getting started with your project
+![Demo](https://github.com/linhns/pyfalldown/blob/main/docs/assets/images/pyfalldown.gif)
 
-### 1. Create a New Repository
+## Installation
 
-First, create a repository on GitHub with the same name as this project, and then run the following commands:
+- Using [pip](https://github.com/pypa/pip):
 
-```bash
-git init -b main
-git add .
-git commit -m "init commit"
-git remote add origin git@github.com:linhns/pyfalldown.git
-git push -u origin main
-```
+  ```shell
+  pip install pyfalldown
+  ```
 
-### 2. Set Up Your Development Environment
+  Then, run the game:
 
-Then, install the environment and the pre-commit hooks with
+  ```shell
+  pyfalldown
+  ```
 
-```bash
-make install
-```
+  or:
 
-This will also generate your `uv.lock` file
+  ```shell
+  python -m pyfalldown
+  ```
 
-### 3. Run the pre-commit hooks
+- Run without installation using [uv](https://github.com/astral-sh/uv):
 
-Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
+  ```shell
+  uvx pyfalldown
+  ```
 
-```bash
-uv run pre-commit run -a
-```
+## Rules
 
-### 4. Commit the changes
+- The game is over if the ball hits the top or bottom edge of the screen.
+- Collecting a triangle earns you a random score between 1 and 5 points.
+- Hitting a square deducts a random 1 to 5 points from your score.
 
-Lastly, commit the changes made by the two steps above to your repository.
+## Usage
 
-```bash
-git add .
-git commit -m 'Fix formatting issues'
-git push origin main
-```
-
-You are now ready to start development on your project!
-The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
-
-To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
-For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
-To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).
-
-## Releasing a new version
-
-- Create an API Token on [PyPI](https://pypi.org/).
-- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/linhns/pyfalldown/settings/secrets/actions/new).
-- Create a [new release](https://github.com/linhns/pyfalldown/releases/new) on Github.
-- Create a new tag in the form `*.*.*`.
-
-For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).
-
----
-
-Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).
+- Move ball using `Left`/`Right` arrow keys.