PartsBin: update and beautify the ReadMe

As we added some features and adapted some, we update the PartsBin Readme file to reflect the changes.
Change-Id: I13c2951990db4d2277cbb9ee86b0f3af58e298d9

1 files changed, 98 insertions, 62 deletions

diff --git a/README.md b/README.md
index 3234477..f95266c 100644
--- a/README.md
+++ b/README.md
@@ -1,120 +1,156 @@
 # PartsBin
 [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](./LICENSE.txt)
 
-**A configurable collection of settings for OnePlus phones.**
+*A configurable collection of settings for OnePlus phones.*
 
-Currently supporting
+### Currently supported devices:
 
-	op5: Cheeseburger
+  * OnePlus 5:      cheeseburger
+  * OnePlus 5T:     dumpling
+  * OnePlus 6:      enchilada
+  * OnePlus 6T:     fajita
+  * OnePlus 7:      guacamoleb
+  * OnePlus 7 Pro:  guacamole
+  * OnePlus 7T Pro: hotdog
 
-	op5t: Dumpling
+### Description
 
-	op6: Enchilada
-
-	op7: Guacamoleb
-
-Idea is to manage device specific settings from a common code base while allowing
-features/implementations unique to individual devices to coexist with common
-ones. Feature availability is controlled by adding various overlays to the device
+Based on OMNIROMs DeviceParts package, the idea is to manage device specific
+settings from a common code base while allowing features/implementations
+to be unique to individual devices to coexist with common ones.
+Feature availability is controlled by adding various overlays to the device
 tree for this package. Overlays are mostly sysfs paths controlling that particular
-feature. This application must have proper file access and sepolicy security contexts
-to those sysfs paths.
+feature.
+This application must have proper file access and sepolicy security contexts to those sysfs paths.
+
+Resource strings are used from https://github.com/AICP/packages_resources_deviceparts
 
-Resources are used from https://github.com/AICP/packages_resources_deviceparts
+### Currently supported features include:
 
-Currently supported features include:
+**Toggles and Paths**
 
-	*Toggles*
+_Note that defining paths needs support in the kernel! Thus the features might not work, if you are using a custom kernel._
 
 	HWKSwitch: Hardware keys swap toggle (supported on devices hw nav keys)
 
-	HBMSwitch: High Brightness Mode toggle with configurable off-on values
+	Offscreen-gestures: Only set to true, if the device supports Screengestures while the display is off.
 
-	DCDSwitch: DC Dimming toggle
+	Doubletap to wake (DT2W): En-/disable waking up the display by tapping on it two times.
 
-	Panel Modes: sRGB, DCI-P3, WideColor, OnePlus
+	Sweep to wake (S2W): En-/disable waking up the display by swiping from left to right in the lower section.
 
-	Vibration Modes: System, Calls, Notifications
-	*if any vibration is used, 3 integer vibrator overlays **must** be defined
+	SoundTuner: En-/disable the proprietary SoundTuner (OnePlus specific)
 
-	*ScreenOffGestures*
+	HBMSwitch: High Brightness Mode toggle with configurable off-on values with additional QS tile
 
-	Single Tap - to display ambient mode
+	DCDSwitch: DC-Dimming toggle with additional QS tile
 
-	Music Control - Play/Pause, skip to prev or next track
+	Displaypanel Color Modes: sRGB, DCI-P3, WideColor, OnePlus, Nightmode. With additional QS tile
 
-	O-W-M-S Gestures - configurable
+	Display Refreshrate: Automatic, Manual (60Hz, 90Hz) with additional QS tile
+	[Note: Requires setting the kernel node for "dynamic_fps" and a few other bools.]
 
-	Left-Right-Up-Down Swipes - configurable
+	Vibration Modes: System, Calls, Notifications
+	[Note: For a vibration to work the corresponding integer vibrator overlays must be defined.]
 
-	Down Arrow Gesture - configurable
+	Fastcharge: En-/disable USB charging with max. 900mA
 
-	*AlertSlider*
+**Screen-Off Gestures (with optional haptic feedback)**
 
-	Top-Center-Bottom positions with position bubbles
+	SingleTap - to display ambient mode
 
-	Possible selections:
+	Music Control - Play/Pause ("||"), skip to previous ("<") or next (">") track
 
-	Ringer: Ring, vibrate, silent
+	Letter "O", "W", "M", "S", "V", "A" Gestures - configurable
 
-	Zen mode: priority only, alarms only, do not disturb
+	Left-Right-Up-Down Swipes - configurable
 
-	Flashlight
+**Fingerprintreader Swiping Gestures (on non-FOD devices)**
 
-**Configurable overlays.**
+	Left-Right-Up-Down Fingerprint-Swipes - configurable
+	[Note: Down-Swipe can also be disabled in favour of the AOSP build-in gesture.]
 
-	\<!-- Whether device supports disabling hwkeys -->
+**AlertSlider**
 
-	\<string name="pathHWKToggle">\</string>
+	Top-Center-Bottom positions with position bubbles
 
-	\<!-- Path to devices single-tap toggle file -->
+	Possible selections:
 
-	\<string name="pathSTapToggle">\</string>
+	  - Ringer: ring, vibrate, silent
+	  - Zen mode: priority only, alarms only, do not disturb
+	  - Flashlight
 
-	\<!-- Path to devices High Brigness Mode toggle file -->
+**Configurable overlays**
 
-	\<string name="pathHBMModeToggle">\</string>
+`<!-- Whether the device has hardware navigation buttons (true/false) -->`<br />
+`<bool name="config_device_has_hw_nav_buttons"> </bool>`<br />
 
-	\<string name="hbmOFF">"0"\</string>
+`<!-- Whether the device supports offscreen-gestures (true/false) -->`<br />
+`<bool name="config_device_supports_gestures"> </bool>`<br />
 
-	\<string name="hbmON">"1"\</string>
+`<!-- Whether the device supports the prebuilt SoundTuner (true/false) -->`<br />
+`<bool name="config_device_supports_soundtuner"> </bool>`<br />
 
-	\<!-- Path to devices High Brigness Mode toggle file -->
+`<!-- Whether device supports switching display refreshrates (true/false) -->`<br />
+`<bool name="config_device_supports_switch_refreshrate"> </bool>`<br />
 
-	\<string name="pathOnePlusModeToggle">\</string>
+`<!-- Show/hide the QS tile, if device supports DC Dimming or not. Default value is false. -->`<br />
+`<bool name="enableDCDTile">false</bool>`<br />
 
-	\<!-- Path to devices SRGBMode toggle file -->
+`<!-- Show/hide the QS tile, if device supports switching display refreshrates or not. Default value is false. -->`<br />
+`<bool name="enableRefreshrateTile">false</bool>`<br />
 
-	\<string name="pathSRGBModeToggle">\</string>
+`<!-- Show/hide the QS tile, if device supports switching Displaymodes or not. Default value is false. -->`<br />
+`<bool name="enablePanelModeTile">false</bool>`<br />
 
-	\<!-- Path to devices DCIMode toggle file -->
+`<!-- Show/hide the QS tile, if device supports switching HighBrightness mode or not. Default value is false. -->`<br />
+`<bool name="enableHBMModeTile">false</bool>`<br />
 
-	\<string name="pathDCIModeToggle">\</string>
+`<!-- Whether device supports disabling hwkeys -->`<br />
+`<string name="pathHWKToggle"> </string>`<br />
 
-	\<!-- Path to devices DCDMode toggle file -->
+`<!-- Path to devices single-tap toggle file -->`<br />
+`<string name="pathSTapToggle"> </string>`<br />
 
-	\<string name="pathDCDModeToggle">\</string>
+`<!-- Path to devices doubletap to wake toggle file -->`<br />
+`<string name="pathDoubleTapToWakeToggle"> </string>`<br />
 
-	\<!-- Path to devices WideMode toggle file -->
+`<!-- Path to devices sweep to wake toggle file -->`<br />
+`<string name="pathSweepToWakeToggle"> </string>`<br />
 
-	\<string name="pathWideModeToggle">\</string>
+`<!-- Path to devices High Brightness Mode toggle file -->`<br />
+`<string name="pathHBMModeToggle"> </string>`<br />
+`<string name="hbmOFF">"0"</string>`<br />
+`<string name="hbmON">"1"</string>`<br />
 
-	\<!-- Whether device allow changing system vibrationlevels -->
+`<!-- Path to devices OnePlus Mode toggle file -->`<br />
+`<string name="pathOnePlusModeToggle"> </string>`<br />
 
-	\<string name="pathSystemVibStrength">\</string>
+`<!-- Path to devices SRGBMode toggle file -->`<br />
+`<string name="pathSRGBModeToggle"> </string>`<br />
 
-	\<!-- Whether device allow changing calls vibrationlevels -->
+`<!-- Path to devices DCI-P3 Mode toggle file -->`<br />
+`<string name="pathDCIModeToggle"> </string>`<br />
 
-	\<string name="pathCallVibStrength">\</string>
+`<!-- Path to devices Nightmode toggle file -->`<br />
+`<string name="pathNightModeToggle"> </string>`<br />
 
-	\<!-- Whether device allow changing notification vibrationlevels -->
+`<!-- Path to devices DC-Dimming Mode toggle file -->`<br />
+`<string name="pathDCDModeToggle"> </string>`<br />
 
-	\<string name="pathNotifVibStrength">\</string>
+`<!-- Path to devices WideMode toggle file -->`<br />
+`<string name="pathWideModeToggle"> </string>`<br />
 
-	\<!-- Device vibrator min-max-default values -->
+`<!-- Path to devices system vibrationlevels -->`<br />
+`<string name="pathSystemVibStrength"> </string>`<br />
 
-	\<integer name="vibratorMinMV">\</integer>
+`<!-- Path to devices calls vibrationlevels -->`<br />
+`<string name="pathCallVibStrength"> </string>`<br />
 
-	\<integer name="vibratorMaxMV">\</integer>
+`<!-- Path to devices notification vibrationlevels -->`<br />
+`<string name="pathNotifVibStrength"> </string>`<br />
 
-	\<integer name="vibratorDefaultMV">\</integer>
+`<!-- Device vibrator min-max-default values -->`<br />
+`<integer name="vibratorMinMV"> </integer>`<br />
+`<integer name="vibratorMaxMV"> </integer>`<br />
+`<integer name="vibratorDefaultMV"> </integer>`<br />