changelog initial commit

fixes #1

add example valid vban.toml to readme

CHANGELOG.md

@@ -0,0 +1,57 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+-   [ ] Ability to set a profile to load on startup
+-   [ ] Add more substantial example profile config files.
+
+## [1.0.0] - 2022-04-27
+
+### Added
+
+-   Example of valid vban.toml to readme
+
+### Changed
+
+-   Sun-Valley theme added as module. Added to pysetup. Img files removed from repo.
+-   Major version bump since this is not backwards compatible.
+
+### Fixed
+
+-   Fix issue with bus modes syncing. Added a bus mode cache to App class.
+
+## [0.0.1] - 2022-04-22
+
+### Added
+
+-   App initial commit.
+-   Strip/Bus frames implemented
+    -   A labelframe for each channel containing a progressbar and slider.
+    -   A config frame for setting inputs/outputs, comp, gate, limit, mono, eq, bus modes.
+-   Navigation frame implemented
+    -   Extending horizontally/vertically implemented.
+-   Submixes frames implemented
+    -   Each submix frame offers a view of all input devices on a single bus.
+    -   Possible to select any one of all 8 buses.
+    -   ON button implemented, effectively a mute toggle.
+-   Menus implemented.
+    -   Voicemeeter action type functions for the main GUI.
+    -   Profiles load any profile defined in profiles/ directory for a kind. Reset to defaults.
+    -   VBAN Connect connect to any number of connections defined in vban.toml
+    -   Extends toggle direction app extends in.
+    -   Submixes select the bus the Submix frame will represent. Selecting a new bus will redraw the submix frame if its gridded.
+    -   Themes toggle light/dark sunvalley theme.
+    -   Help links to sites.
+
+### Changed
+
+-   Only create banner frame if kind is Potato.
+
+### Fixed
+
+-   Fix bug where submixes menu remained disabled if kind changes when switching between vmr and vban interface. (ie banana remote to potato local)

README.md

@@ -1,10 +1,15 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/onyx-and-iris/voicemeeter-compact/blob/main/LICENSE)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+![OS: Windows](https://img.shields.io/badge/os-windows-red)
 
 ![Image of app/potato size comparison](./doc_imgs/potatocomparisonsmaller.png)
 
 # Voicemeeter Compact
 
+A compact Voicemeeter remote app, works locally and over LAN.
+
+For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
+
 ## Prerequisites
 
 -   Voicemeeter (Basic v1.0.8.2), (Banana v2.0.6.2) or (Potato v3.0.2.2)
@@ -127,6 +132,22 @@ Configure as many vban connections as you wish. This allows the app to work over
 
 For vban connections to work correctly VBAN TEXT incoming stream MUST be configured correctly on the remote machine. Both pcs ought to be connected to a local private network and should be able to ping one another.
 
+A valid vban.toml might look like this:
+
+```toml
+[connection-1]
+kind = 'banana'
+ip = '192.168.1.2'
+streamname = 'streampc'
+port = 6990
+
+[connection-2]
+kind = 'potato'
+ip = '192.168.1.3'
+streamname = 'worklaptop'
+port = 6990
+```
+
 ## Profiles
 
 Three example profiles are included with the package, one for each kind of Voicemeeter. Use these to configure parameter startup states. Any parameter supported by the underlying interfaces may be used. For a detailed description of parameter coverage see: