Add README.md

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+github: newhinton
+custom: ["https://www.paypal.com/paypalme/felixnuesse"]
+liberapay: newhinton

README.md

@@ -0,0 +1,88 @@
+# Timed Silence - Dont let your phone rattle you!
+[![license: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/newhinton/timed-silence/blob/master/LICENSE) [![Latest Downloads](https://img.shields.io/github/downloads/newhinton/timed-silence/latest/total
+)](https://github.com/newhinton/timed-silence/releases) [![GitHub release](https://img.shields.io/github/v/release/newhinton/timed-silence?include_prereleases)](https://github.com/newhinton/timed-silence/releases/latest)
+[![Documentation](https://img.shields.io/badge/Documentation-roundsync.com-4aad4e)](https://roundsync.com) [![supportive flags](https://img.shields.io/badge/support-🇺🇦_🏳️‍⚧_🏳️‍🌈-4aad4e)](https://roundsync.com)
+
+[![Android Lint](https://github.com/newhinton/timed-silence/actions/workflows/lint.yml/badge.svg)](https://github.com/newhinton/timed-silence/actions/workflows/lint.yml)
+-----------
+An app that manages your phones volume. It will mute your phone for you, so that you never get disturbed when doing important things!
+
+<br/>
+<br/>
+
+Screenshots
+-----------
+
+<table>
+  <tr style="border:none">
+    <td style="border:none">
+      <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/1.png" width="360vh" />
+    </td>
+    <td style="border:none">
+      <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/2.png" width="360vh" />
+    </td>
+    <td style="border:none">
+      <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/3.png" width="360vh" />
+    </td>
+  </tr>
+</table>
+
+
+
+
+Features
+--------
+
+- **Time** Create schedules for when your phone should be muted or loud
+- **Calendar** Let your calendar manage the volume for you. Depending on events, your phone will be silent!
+- **Keywords** If you have specific events, keywords will help you get the silence you need!
+
+Installation
+------------
+Grab the [latest version](https://github.com/newhinton/timed-silence/releases/latest) of the signed APK and install it on your phone.
+
+
+Developing
+------------
+
+You should first make sure you have cloned this repository:
+
+
+```sh
+git clone https://github.com/newhinton/timed-silence
+```
+
+
+You can then build the app normally from Android Studio or from CLI by running:
+
+```sh
+# build
+./gradlew assemble
+
+```
+
+
+Contributing
+------------
+See [CONTRIBUTING](./CONTRIBUTING.md)
+
+Anyone is welcome to contribute and help out. However, hate, discrimination and racism are decidedly unwelcome here. If you feel offended by this, you might belong to the group of people who are not welcome. I will not tolerate hate in any way.
+
+
+Donations
+------------
+
+If you like my work, either this app or in general, you are more than welcome to leave a donation.
+It helps me to dedicate time to further improve my apps!
+
+[Paypal](https://www.paypal.com/paypalme/felixnuesse)
+Other ways are available too, check the sidebar for the donations-section.
+
+License
+-----------------
+### About this app
+This app is released under the terms of the [GPLv3 license](https://github.com/newhinton/timed-silence/blob/master/LICENSE). 
+
+### Libraries
+- [Balloon - Tooltips](https://github.com/skydoves/Balloon) - This helps us to show you detailed information, that you might not need on a first glance.
+- [AppIntro](https://github.com/AppIntro/AppIntro) - This library is responsible for the easy-to-use introduction to the app!