Updated README.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..2ba75bc
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,22 @@
+# How To Contribute
+
+## New Features
+
+If you have the next great idea for this little tool, you are welcome to open an
+issues with your idea. This is how WiFi- and Bluetooth-based muting came to life 🙂
+
+If your idea is too big for the scope of this tool or I don't have the time to
+implement it, I'll let you know and you are free to provide a PR with the code,
+if you have the time to provide the code yourself.
+
+# Bug fixes
+
+You're welcome at any time to provide pull requests with fixes for bugs you discovered.
+Try to keep it in the current coding style as much as possible. Otherwise I won't
+dictate any strict rules.
+
+# Internationalization
+WinMute would greatly benefit from transalation. As of now WinMute does not support
+any form of i18n.
+If you know how to best implement i18n in a simple WinAPI app, I'd be happy if you
+could help out with implementing the basic infrastructure for it.
\ No newline at end of file

diff --git a/Dist/screenshots/settings.gif b/Dist/screenshots/settings.gif
new file mode 100644 (file)
index 0000000..083fdf1
Binary files /dev/null and b/Dist/screenshots/settings.gif differ

diff --git a/README.md b/README.md
index 4bff43df8be80a8751a20a9abd1009156e1b5449..22e35f22b1d4b1df4f11a4b17f972787ba35606f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,43 +1,57 @@
-# WinMute #
-
-### About ###
-WinMute can automatically mute all sound devices on your PC when
+# WinMute
+
+<!-- logo -->
+<div align="center">
+   <img alt="Logo" src="WinMute/icons/app.png">
+</div>
+
+*WinMute* is a simple tool, that automatically mutes (and unmutes) your workstation
+based on triggers, e.g. the screensaver starts, or your bluetooth headphone disconnects.
+
+It was created to not repeatedly annoy my co-workers with random sounds or music from my
+computer whenever I left the room and forgot to mute all sounds.
+
+## Features
+* WinMute can automatically mute all sound devices on your workstation when:
+  * you lock your workstation.
+  * the screensaver turns on.
+  * the display turns off.
+  * you log off or switch user.
+  * your workstation shuts down, goes into hibernate or goes to sleep.
+  * your bluetooth headset/headphones disconnect.
+  * your workstation is connected to a particular wireless network.
+    * alternatively: your Workstation is _not_ connected to particular wireless network
+* WinMute is small and only needs a few kilobytes disk space
+* WinMute is ad-free, telemetry-free and generally does not send any data whatsoever
+
+## Screenshots
+![Screenshot of WinMute](https://raw.githubusercontent.com/lx-s/WinMute/master/Dist/screenshots/app.png? "Screenshot of WinMute")
+![Screenshot of the Settings](https://raw.githubusercontent.com/lx-s/WinMute/master/Dist/screenshots/settings.gif? "Settings dialog")
 
-* you lock your PC.
-* the screensaver turns on.
-* the display turns off
-* you log off
-* your PC shuts down
-* your PC goes to sleep
-* your Bluetooth headset disconnects
-* your PC is connected to a particular wireless network
-  * alternatively: your pc is not connected to particular wireless network
+## Development
 
-This is very helpful e.g. if you leave your desk and don't want to annoy your co-workers with random sounds or music from your computer or don't want music blasting out of your speakers, the next time you power on your pc during a presentation.
+Check out [CONTRIBUTING.md](CONTRIBUTING.md), if you are interested in participating.
 
-### Screenshots ###
-![Screenshot of WinMute](https://raw.githubusercontent.com/lx-s/WinMute/master/Dist/screenshots/app.png? "Screenshot of WinMute")
-![Screenshot of the Settings](https://raw.githubusercontent.com/lx-s/WinMute/master/Dist/screenshots/settings_general.png? "Screenshot of the Settings")
-![Screenshot of the QuietHour-Settings](https://raw.githubusercontent.com/lx-s/WinMute/master/Dist/screenshots/settings_quiethours.png? "Screenshot of the QuietHour-Settings")
-![Screenshot of the WLAN-Settings](https://raw.githubusercontent.com/lx-s/WinMute/master/Dist/screenshots/settings_wlan.png? "Screenshot of the WLAN-Settings")
-![Screenshot of the Bluetooth-Settings](https://raw.githubusercontent.com/lx-s/WinMute/master/Dist/screenshots/settings_bluetooth.png? "Screenshot of the WLAN-Settings")
+## Usage
 
-### Requirements ###
+### Requirements
 * Windows Vista or any newer version of Windows.
-* [Visual Studio 2022 Redistributable](https://support.microsoft.com/help/2977003/the-latest-supported-visual-c-downloads)
+* [Visual Studio 2015-2022 Redistributable](https://support.microsoft.com/help/2977003/the-latest-supported-visual-c-downloads)
 
-### Installation ###
-Unzip it to your favourite directory and you are all set up!
+### Installation
+Either unzip it to your favourite directory or run the WinMute-Setup.msi and you are all set up!
 
-### Uninstalling WinMute ###
-Just delete the `WinMute.exe` and `ScreensaverNotify.dll` file from your hard drive.
+### Uninstalling WinMute
+Just delete the WinMute-directory (or uninstall it from Windows' Apps control panel),
 
 If you want to also remove your personal WinMute settings, open the registry via `regedit.exe` and delete the Folder located in `HKEY_CURRENT_USER\Software\lx-systems\WinMute`.
 
-*Note:* It's possible that you cannot remove the `ScreensaverNotify.dll` file right away. If you get an error trying to remove it, just wait until your next reboot and delete it afterwards. This is unfortunately a windows limitation.
+*Note:* It's possible that you cannot remove the `ScreensaverNotify*.dll` file right away. If you get an error trying to remove it, just wait until your next reboot and delete it afterwards. This is unfortunately a windows limitation.
 
-### Usage ###
+### How to (un)mute
 Just start it and you are good to go!
 
 Whenever you lock your screen from now on or the screensaver starts, WinMute will automatically mute your windows volume, and unmute it right away when you come back to your pc.
 If you want to change the behaviour or explore all the other options, right-click on the taskbar notification icon and explore!
+
+