Update README.md

README.md

@@ -0,0 +1,68 @@
+<div align="center">
+  <h1>Keepass Fidelity</h1>
+  <p>A minimalist fidelity/loyalty card plugin</p>
+  <img src="https://forthebadge.com/images/badges/built-for-android.svg" alt="Built for Android">
+  <img src="https://forthebadge.com/images/badges/built-with-love.svg" alt="Built with love">
+  <br>
+    <a href="https://github.com/choelzl/keepass-fidelity/actions/workflows/build.yml">
+    <img src="https://github.com/choelzl/keepass-fidelity/actions/workflows/build.yml/badge.svg?branch=main" alt="Build Status">
+  </a>
+</div>
+
+## 🌄 Screenshots
+
+<div align="center">
+  <table>
+    <tr>
+      <td style="width: 33%; height: 100px;"><img src=".github/images/launcher.jpg" alt="Launcher" style="width: 100%; height: 100%;"></td>
+      <td style="width: 33%; height: 100px;"><img src=".github/images/view.jpg" alt="View" style="width: 100%; height: 100%;"></td>
+      <td style="width: 33%; height: 100px;"><img src=".github/images/edit.jpg" alt="Edit" style="width: 100%; height: 100%;"></td>
+    </tr>
+  </table>
+</div>
+
+## ⭐ Features
+
+- Search entries in [Keepass2Android](https://github.com/PhilippC/keepass2android/)
+- Scan & Create entries
+- Recently used history for fast access
+- Protect entries from caching
+- Minimalist design and features
+
+## 📳 Installation
+
+<div style="display: flex; justify-content: center; align-items: center; flex-direction: row;">
+    <a href="" style="display:none">
+        <img width="200" height="80" alt="Izzy Download" src=".github.images/izzy.png">
+    </a>
+    <a href="https://github.com/choelzl/keepass-fidelity/releases/latest">
+        <img width="200" height="84" alt="APK Download" src=".github/images/apk">
+    </a>
+</div>
+
+## ⚙️ Permissions
+
+- `CAMERA`: necessary for the scanning of barcodes
+
+## 📝 Contribute
+
+Keepass-Fidelity is a user-driven project. We welcome any contribution, big or small.
+
+- **🖥️ Development:** Fix bugs, implement features, or research issues. Open a PR for review.
+- **🍥 Design:** Improve interfaces, including accessibility and usability.
+- **📂 Issue Reporting:** Report bugs and edge cases with relevant info.
+- **🌍 Localization:** Translate if it doesn't support your language.
+
+## ✏️ Acknowledgements
+
+Thanks to all contributors, the developers of our dependencies, and our users.
+
+
+## 📝 License
+
+```
+Copyright (C) 2024 Helcel
+
+Licensed under the Unlicense
+For more information, please refer to <https://unlicense.org>
+```