README + 0.1.1

Author: phip1611

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "max-7219-led-matrix-util"
-version = "0.1.0"
+version = "0.1.1"
 authors = ["Philipp Schuster <phip1611@gmail.com>"]
 edition = "2018"
 exclude = [

Cargo.toml

@@ -10,4 +10,31 @@ to access GPIO. Should work on other Linux powered devices with GPIO hardware to
 
 Feel free to learn from the code or to contribute!
 
-![demo](demo.gif)
+![demo](demo.gif)
+
+## Usage example
+```
+use max_7219_led_matrix_util::setup::setup;
+use max_7219_led_matrix_util::{shop_moving_text_in_loop, prepare_display};
+
+const NUM_DISPLAYS: usize = 4;
+
+fn main() {
+    // provide three args for the three pins
+    let args: Vec<String> = std::env::args().collect();
+    assert_eq!(args.len(), 4, "Provide three args!");
+
+    let data_pin = args[1].parse::<u32>().unwrap();
+    let cs_pin = args[2].parse::<u32>().unwrap();
+    let clk_pin = args[3].parse::<u32>().unwrap();
+
+    println!("data={}, cs={}, clk={}", data_pin, cs_pin, clk_pin);
+
+    let mut display = setup("/dev/gpiochip0", NUM_DISPLAYS, data_pin, cs_pin, clk_pin);
+    prepare_display(&mut display, NUM_DISPLAYS, 0x0F);
+    shop_moving_text_in_loop(&mut display, "HELLO 01 ABCDEF    ", NUM_DISPLAYS, 50);
+}
+```
+
+`max_7219_led_matrix_util::setup::setup` returns an instance of a struct defined by crate `max7219` (the actual device driver).
+Therefore you can work directly on this driver too without the need of the utility functions. Like `display.write_raw()`.

README.md

@@ -23,6 +23,6 @@ fn main() {
     println!("data={}, cs={}, clk={}", data_pin, cs_pin, clk_pin);
 
     let mut display = setup("/dev/gpiochip0", NUM_DISPLAYS, data_pin, cs_pin, clk_pin);
-    prepare_display(&mut display, NUM_DISPLAYS, 0x0F); // already done inside shop_moving_text_in_loop() :)
+    prepare_display(&mut display, NUM_DISPLAYS, 0x0F);
     shop_moving_text_in_loop(&mut display, "HELLO 01 ABCDEF    ", NUM_DISPLAYS, 50);
 }