Merge pull request #2 from ChickenStorm/develop

v0.2.1

Author: ChickenStorm

.github/dependabot.yml

@@ -5,4 +5,4 @@ updates:
   schedule:
     interval: daily
   open-pull-requests-limit: 10
-  target-branch: develop
+  target-branch: main

.github/workflows/fmt.yml

@@ -18,11 +18,11 @@ jobs:
     - name: Checkout repository
       uses: actions/checkout@v2
 
-    - name: Install Rust stable toolchain
+    - name: Install Rust nightly toolchain
       uses: actions-rs/toolchain@v1
       with:
-        toolchain: stable
+        toolchain: nightly
         components: rustfmt,
 
     - name: fmt
-      run: cargo fmt --all -- --check
+      run: cargo +nightly fmt --all -- --check

.github/workflows/rust_doc.yml

@@ -2,7 +2,7 @@ name: Rust-Doc
 
 on:
   push:
-    branches: [ main, develop ]
+    branches: [ main ]
 
 env:
   CARGO_TERM_COLOR: always

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "roccat-vulcan-api-rs"
-version = "0.2.0"
+version = "0.2.1"
 authors = ["ChickenStorm <[email protected]>"]
 edition = "2018"
 readme = "README.md"

README.md

@@ -1,4 +1,12 @@
+
+
 # roccat-vulcan-api-rs
+
+![license](https://img.shields.io/github/license/ChickenStorm/roccat-vulcan-api-rs)
+[![](https://img.shields.io/badge/doc-Read_Me-blue)](https://chickenstorm.github.io/roccat-vulcan-api-rs/roccat_vulcan_api_rs/index.html)
+![Build](https://img.shields.io/github/workflow/status/ChickenStorm/roccat-vulcan-api-rs/Rust)
+[![codecov](https://codecov.io/gh/ChickenStorm/roccat-vulcan-api-rs/branch/main/graph/badge.svg?token=Z1J8KMKLC1)](https://codecov.io/gh/ChickenStorm/roccat-vulcan-api-rs)
+
 **Roccat Vulcan keyboard illumination API.**  
 A fast multiplatform API to control Roccat Vulcan illumination.
 
@@ -7,32 +15,29 @@ Provide an API to control the lighting of the Roccat Vulcan 100 and 120.
 # Usage
 
 add on your dependencies of Cargo.toml
-`roccat-vulcan-api-rs = { version = "0.1.1", git = "https://github.com/ChickenStorm/roccat-vulcan-api-rs", branch = "main" }`.
+`roccat-vulcan-api-rs = { version = "0.2.1", git = "https://github.com/ChickenStorm/roccat-vulcan-api-rs", branch = "main" }`.
 
-
-The main way to interact with the API is through `KeyboardApi`.
+The main way to interact with the API is through [`KeyboardApi`].
 Note that when the structure is dropped the keyboard will go back to the default rainbow behavior.
 
 
 # Layout
-For the moment only Swiss French layout is supported. To support other layout implement the trait `Layout`.
+For the moment only Swiss French layout is supported. To support other layout implement the trait [`Layout`].
 
 # Examples
 To load and initialized a keyboard use
 ```rust
-use roccat_vulcan_api_rs::{KeyboardApi, config, ColorBuffer, ColorRgb};
-use std::{
-    thread::sleep,
-    time::Duration,
-};
-
-let keyboard = KeyboardApi::get_api().unwrap();
-let buffer = ColorBuffer::new(ColorRgb::new(255, 255, 255));
-keyboard.render(&buffer).unwrap();
+use std::{thread::sleep, time::Duration};
+use roccat_vulcan_api_rs::{ColorBuffer, ColorRgb, ErrorRoccatVulcanApi, KeyboardApi};
+
+# fn main() -> Result<(), ErrorRoccatVulcanApi> {
+# #[cfg(not(feature = "no-keyboard-test"))]
+# {
+let keyboard = KeyboardApi::new()?;
+let buffer = ColorBuffer::from_element(ColorRgb::new(255, 255, 255));
+keyboard.render(&buffer)?;
 sleep(Duration::from_secs(1));
+# }
+# Ok(())
+# }
 ```
-
-### Acknowledgement
-
-- I thank [simonhuwiler](https://github.com/simonhuwiler/roccatvulcan) and [duncanthrax](https://github.com/duncanthrax/roccat-vulcan) for their code which this library is based on.  
-- And a big thank you to Bidoubioche for helping me learn rust and for always answering my question and the help figuring my way through the compiler messages 

examples/render_loop.rs

@@ -1,8 +1,9 @@
+use std::time::Duration;
+
 use roccat_vulcan_api_rs::{
     ColorBuffer, ColorRgb, ErrorRoccatVulcanApi, KeyName, KeyboardApi, Layout, LayoutFrCh,
     NUMBER_KEY_LED_BUFFER,
 };
-use std::time::Duration;
 
 fn main() -> Result<(), ErrorRoccatVulcanApi> {
     let mut key_press_mask: [bool; NUMBER_KEY_LED_BUFFER] = [false; NUMBER_KEY_LED_BUFFER];

rustfmt.toml

@@ -0,0 +1,4 @@
+format_code_in_doc_comments = true
+group_imports = "StdExternalCrate"
+unstable_features = true
+use_field_init_shorthand = true

src/color.rs

@@ -1,3 +1,5 @@
+//! Contains the color and [`ColorBuffer`]
+
 mod base;
 pub use base::*;