Merge pull request #7 from davidchalifoux/main

v0.0.5
davidchalifoux · Feb 19, 2024 · 9fc9ee9 · 9fc9ee9
2 parents fbf4815 + ed1c9ef
commit 9fc9ee9
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,32 @@
-# Tauri + React + Typescript
+<p>
+    <img src="./readme-images/icon.png" width="128" alt="Motrix App Icon" />
+</p>
 
-This template should help get you started developing with Tauri, React and Typescript in Vite.
+# Keylight Commander
 
-## Recommended IDE Setup
+[![Github Release](https://img.shields.io/github/v/release/davidchalifoux/keylight-commander?style=for-the-badge)](https://github.com/davidchalifoux/keylight-commander/releases/latest)
+[![Github License](https://img.shields.io/github/license/davidchalifoux/keylight-commander?style=for-the-badge)](https://github.com/davidchalifoux/keylight-commander/blob/main/license.md)
+
+Keylight Commander is an open-source and cross-platform application for controlling [Elgato Key Lights](https://www.elgato.com/us/en/p/key-light).
+
+## Features
+
+- Adjust brightness, color temperature, and power
+- Sync adjustments to all lights
+- Give lights nicknames
+- Automatic light discovery via mDNS
+- Manually add lights by IP
+- Uses minimal resources
+- Support for macOS, Windows, and Linux
+
+## Installation
+
+Download the [latest release](https://github.com/davidchalifoux/keylight-commander/releases/latest) for your platform and install it.
+
+## Contributing
+
+Contributions are welcome and highly appreciated. This project is using Tauri and React.
+
+#### Recommended IDE Setup
 
 - [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
diff --git a/index.html b/index.html
@@ -4,7 +4,7 @@
     <meta charset="UTF-8" />
     <link rel="icon" type="image/svg+xml" href="/vite.svg" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Keytrol</title>
+    <title>Keylight Commander</title>
   </head>
 
   <body>

diff --git a/license.md b/license.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 David Chalifoux
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/readme-images/icon.png b/readme-images/icon.png
diff --git a/readme-images/screenshot.png b/readme-images/screenshot.png
diff --git a/src-tauri/tauri.conf.json b/src-tauri/tauri.conf.json
@@ -7,7 +7,7 @@
   },
   "package": {
     "productName": "Keylight Commander",
-    "version": "0.0.4"
+    "version": "0.0.5"
   },
   "tauri": {
     "updater": {