From 453928ff98c38d33347afc68637810d391c2d2e4 Mon Sep 17 00:00:00 2001
From: AbdallahMehiz <abdallahmehiz0@gmail.com>
Date: Sun, 18 Aug 2024 01:07:20 +0100
Subject: [PATCH] chore: create a readme simple... for now.

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..644b779
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# <img alt="app icon" src=".github/assets/app_icon.svg" width="48" /> mpvKt
+A media player for Android based on [mpv-android](https://github.com/mpv-android/mpv-android) aiming to provide a *nicer* user interface over the original.
+
+[![Build](https://github.com/abdallahmehiz/mpvKt/actions/workflows/build.yml/badge.svg)](https://github.com/abdallahmehiz/mpvKt/actions/workflows/build.yml)
+## Additional features
+ - Nicer player UI
+ - Better playback history implementation
+ - Easier customization
+
+## Installation
+For now, you can access pre-releases on the [Github releases page](https://github.com/abdallahmehiz/mpvKt/releases).
+
+## Acknowledgments
+ - [mpv-android](https://github.com/mpv-android) for the base mpv library to use for this project.