Updated README for 1.3.0

README.md

@@ -1,46 +1,50 @@
-# Instant Replay Suite [![Latest Release](https://img.shields.io/github/release/thisismy-github/instant-replay-suite/all.svg)](https://github.com/thisismy-github/instant-replay-suite/releases/latest) [![Lines of code](https://img.shields.io/tokei/lines/github/thisismy-github/instant-replay-suite)](https://github.com/thisismy-github/instant-replay-suite/releases) [![Download Count](https://img.shields.io/github/downloads/thisismy-github/instant-replay-suite/total?color=success)](https://github.com/thisismy-github/instant-replay-suite/releases) [![Stars](https://img.shields.io/github/stars/thisismy-github/instant-replay-suite?color=success)](https://github.com/thisismy-github/instant-replay-suite/stargazers)
+# Instant Replay Suite [![Latest Release](https://img.shields.io/github/release/thisismy-github/instant-replay-suite/all.svg)](https://github.com/thisismy-github/instant-replay-suite/releases/latest) [![Download Count](https://img.shields.io/github/downloads/thisismy-github/instant-replay-suite/total?color=success)](https://github.com/thisismy-github/instant-replay-suite/releases) [![Stars](https://img.shields.io/github/stars/thisismy-github/instant-replay-suite?color=success)](https://github.com/thisismy-github/instant-replay-suite/stargazers)
 
 A suite of tools for formatting and editing Instant Replay clips, both in-game and out.
 
 ![Screenshot #1](https://i.imgur.com/6Q4S8r6.png)
 
 # Core Features
 
-## Trimming
+### Trimming
 
 Use customizable hotkeys to instantly trim clips to any length you choose (defaults to `Alt + 1-9` for 10-90 seconds), or enter the length yourself using your number keys (defaults to `Alt + 0`). Requires [FFmpeg](https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-essentials.zip).
 
-## Splicing
+### Splicing
 
-Instantly concatenate/splice the last two clips together (defaults to `Alt + C`). Requires [FFmpeg](https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-essentials.zip).
+Prematurely saved a clip? Instantly concatenate the last two clips together (defaults to `Alt + C`). Requires [FFmpeg](https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-essentials.zip).
 
-## Backups/Undo
+### Merge System/Microphone Tracks
 
-Instantly undo your last edit using backups of your most recently edited clips (defaults to `Alt + U`).
+Merge your system and microphone audio tracks together if you have "Separate both tracks" enabled in ShadowPlay (defaults to `Alt + M`). Requires [FFmpeg](https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-essentials.zip).
 
-## Automatically Rename Clips
+### Backups/Undo
 
-Rename clips as they're saved using a highly customizable naming format. Allows you to set aliases for games while renaming, i.e. "Left 4 Dead 2" becomes "L4D2". A handful of common aliases are included by default.
+Undo your last edit using backups of your most recently edited clips (defaults to `Alt + U`). Access your backups anytime with a folder structure that mimics your videos folder.
 
-## System Tray Icon
+### Automatically Rename Clips
+
+Rename clips *as they're saved* using a highly customizable naming format. Allows you to set aliases for games while renaming, e.g. "Left 4 Dead 2" becomes "L4D2". A handful of common aliases are included by default.
+
+### System Tray Icon
 
 A *highly* customizable tray menu that can be accessed at any time that offers all of the same features listed above. Edit, play, and explore any of your recent clips (not just the latest one!), while getting to see key information about each clip. Offers customizable left-click and middle-click actions.
 
 # Other features
 
-## Auto-updates
+### Auto-updates
 
 GitHub will be checked for a new release every time you launch Instant Replay Suite. If you're using the [compiled release](https://github.com/thisismy-github/instant-replay-suite/releases/latest), you'll have the option to automatically download/install the update straight from GitHub.
 
-## Audio Alerts
+### Audio Alerts
 
 Plays (yes, customizable) .WAV files in real-time to give you audible feedback for various actions being taken, even while in-game.
 
-## Retroactively Add Existing Clips
+### Retroactively Add Existing Clips
 
 On first launch, you'll have the option to add all existing clips in your video folder. This includes renaming any clips using ShadowPlay's naming format to match your desired format.
 
-## Anti-Cheat Safe
+### Anti-Cheat Safe
 
 Instant Replay Suite does **not** simulate any keyboard inputs. It only reads them, making it safe to use online. The cost is that you have to manually save clips yourself and *then* use separate hotkeys to edit them, but this in turn allows you to save clips and worry about editing them later.
 
@@ -51,8 +55,8 @@ See the `executable` folder for details on how to compile (it's REALLY easy).
 - [If you're new to contributing in general, you can use this guide](https://www.dataschool.io/how-to-contribute-on-github/).
 - Follow the [seven rules of a great commit message](https://cbea.ms/git-commit/#seven-rules).
 - Try to match the style of the code surrounding your addition. Don't let your code stick out like a sore thumb.
-- Code should be as self-documenting as possible, with only minor explanatory comments/docstrings (if any).
-- `configparsebetter.py` is currently off-limits (part of a future project).
+- Code should be as self-documenting as possible, but comments, docstrings, and type-hints are welcome.
+- `configparsebetter.py` is off-limits (part of a separate project).
 - Avoid introducing new, heavy dependencies where possible.
-- Avoid relative paths where possible (use `CWD` for the root folder and `pjoin` for creating paths).
+- Avoid relative paths (use `CWD` for the root folder and `pjoin()` for creating paths).
 - Be mindful of `REPOSITORY_URL` when making commits if you change it while testing.