Updated README with more information (#698)

README.md

@@ -1,14 +1,13 @@
-<img src=".github/Icon-1024.png" width="175" alt="App icon" align="left"/>
+<img src=".github/Icon-cropped.png" width="220" alt="App icon" align="left"/>
 
-<h2>MonitorControl - Now with Apple Silicon support</h2>
-        
-<p>
-<b>Control your external display brightness and volume<br>
-Use menulet sliders or the native Apple keyboard keys<br>
-Behaves like native, with (optional) brightness & volume OSD</b>
-</p>
+<div>
+<h2>MonitorControl - for Apple Silicon and Intel</h2>
+<p>Controls your external display brightness and volume and shows native OSD.<br/>
+Use menulet sliders or the keyboard, including native Apple keys!</p>
+<a href="https://github.com/MonitorControl/MonitorControl/releases"><img src=".github/macos_badge_noborder.png" width="175" alt="Download for macOS"/></a>
+</div>
 
-<br/>
+<br/><br/>
  
 <div align="center">
 <!-- shields -->
@@ -36,9 +35,9 @@ Behaves like native, with (optional) brightness & volume OSD</b>
 <br/>
 <br/>
 
-</div>
+<img src=".github/screenshot.png" width="825" alt="Screenshot"/><br/>
 
-<img src=".github/screenshot.png" width="840" alt="Screenshot"/><br/>
+</div>
 
 <hr>
 
@@ -46,6 +45,43 @@ Behaves like native, with (optional) brightness & volume OSD</b>
 
 Go to [Releases](https://github.com/MonitorControl/MonitorControl/releases) and download the latest `.dmg`
 
+## Major features
+
+- Control your display's brightness, volume and contrast!
+- Shows native OSD for brightness and volume.
+- Supports multiple protocols to adjust brightness: DDC for external displays (brightness, contrast, volume), native Apple porotocol for Apple and built-in displays, Gamma table control for software adjustment (recommended for OLED), shade control for AirPlay, Sidecar and Display Link devices.
+- Supports smooth brightness transitions.
+- Seamlessly combined hardware and software dimming extends dimming beyond the minimum brightness available on your display.
+- Synchronize brightness from built-in and Apple screens - replicate Ambient light sensor and touch bar induced changes to a non-Apple external display!
+- Sync up all your displays using a single slider or keyboard shortcuts.
+- Allows dimming to full black (advanced feature).
+- Support for custom keyboard shortcuts as well as standard brightness and media keys on Apple keyboards.
+- Dozens of customization options to tweak the inner workings of the app to suit Your hardware and needs (don't forget to enable `Show advanced settings` in app Preferences).
+- Modern, stylish and highgly customizable menulet reflecting the design of Control Control introduced in Big Sur.
+- Simple, unobstrusive UI to blend in to the general aesthetics of macOS (even the menu icon can be hidden).
+- Supports automatic updates for a hassle-free expereince.
+- <b>The best app of its kind, completely FREE (donations accepted) with the source code transparently available!</b>
+
+## How to install and use the app
+
+1. [Download the app](https://github.com/MonitorControl/MonitorControl/releases)
+2. Copy the MonitorControl app file from the .DMG to your Applications folder
+3. Click on the `MonitorControl` app file
+4. Add the app to `Accessibility` under `System Preferences` » `Security & Privacy` » `Privacy` as prompted (this is required only if you wish to use the native Apple keyboard brightness and media keys - if this is not the case, you can safely skip this step).
+5. Use your keyboard or the sliders in the app menu (a brightness symbol in the macOS menubar as shown on the screenshot above) to control your displays.
+6. Open `Preferences...` for customization options (enable `Show advanced settings` for even more options).
+7. You can set up custom keyboard shortcuts under the `Keyboard` in Preferences (the app uses Apple media keys by default).
+8. If you have any questions, go to [Discussions](https://github.com/MonitorControl/MonitorControl/discussions)!
+
+## Screenshots (Preferences)
+
+<div align="center">
+<img src=".github/pref_1.png" width="410" alt="Screenshot"/>
+<img src=".github/pref_3.png" width="410" alt="Screenshot"/><br/>
+<img src=".github/pref_4.png" width="410" alt="Screenshot"/>
+<img src=".github/pref_2.png" width="410" alt="Screenshot"/><br/>
+</div>
+ 
 ## Compatibility
 
 | MonitorControl version | macOS version     |
@@ -56,6 +92,8 @@ Go to [Releases](https://github.com/MonitorControl/MonitorControl/releases) and
 
 _* With some limitations - full functionality available on macOS 11 Big Sur or newer._
 
+Note to f.lux users: the app is now compatible with [f.lux](https://justgetflux.com) as well - please activate `Avoid gamma table manipulation` under `Preferences` » `Displays` (this option is accessible if advanced settings are enabled)! This is not needed if you use Night Shift.
+
 ## How to help
 
 Open [issues](https://github.com/MonitorControl/MonitorControl/issues) if you have a question, an enhancement to suggest or a bug you've found. If you want you can fork the code yourself and submit a pull request to improve the app.
@@ -73,17 +111,16 @@ MonitorControl supports localization. We gladly welcome your contribution with a
 - [SwiftFormat](https://github.com/nicklockwood/SwiftFormat)
 - [BartyCrouch](https://github.com/Flinesoft/BartyCrouch) (for updating localizations)
 
-Clone the project via this Terminal command:
+### Build steps
+
+- Clone the project via this Terminal command:
 
 ```sh
 git clone https://github.com/MonitorControl/MonitorControl.git
 ```
 
-If you want to clone one of the branches, add `--single-branch --branch [branchname]` after the `clone` option.
-
-You're all set ! Now open the `MonitorControl.xcodeproj` with Xcode! The dependencies will automatically get downloaded once you open the project. If they don't:
-
-`File > Packages > Resolve Package Versions`
+- If you want to clone one of the branches, add `--single-branch --branch [branchname]` after the `clone` option.
+- You're all set ! Now open the `MonitorControl.xcodeproj` with Xcode! The dependencies will automatically get downloaded once you open the project. If they don't: `File > Packages > Resolve Package Versions`
 
 ### Third party dependencies
 
@@ -106,8 +143,6 @@ You're all set ! Now open the `MonitorControl.xcodeproj` with Xcode! The depende
 - [@Bensge](https://github.com/Bensge/) - (used some code from his project [NativeDisplayBrightness](https://github.com/Bensge/NativeDisplayBrightness))
 - [@nhurden](https://github.com/nhurden/) (for the original MediaKeyTap)
 - [@kfix](https://github.com/kfix/ddcctl) (for ddcctl)
-- [@reitermarkus](https://github.com/reitermarkus) (for DDC.Swift)
-- [@zhuowei](https://github.com/zhuowei) (figured out M1 I²C communication)
-- [@tao-j](https://github.com/tao-j) (figured out M1 I²C write)
+- [@reitermarkus](https://github.com/reitermarkus) (for Intel DDC support)
 - [@alin23](https://github.com/alin23) (generally spearheaded M1 DDC support and figured out a many of the caveats)
 - [javierocasio](https://www.deviantart.com/javierocasio) (app icon background)