feat(lib): make it possible to use as a lib

Cargo.toml

@@ -11,7 +11,14 @@ license = "MIT"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-ratatui = "0.25.0"
-crossterm = "0.27.0"
-colors-transform = "0.2.11"
+ratatui = { version = "0.25.0", optional = true }
+crossterm = { version = "0.27.0", optional = true }
 clipboard = "0.5.0"
+
+[[bin]]
+# necessary to avoid including crossterm / ratatui in the lib
+name = "material"
+required-features = ["cli"]
+
+[features]
+cli = ["ratatui", "crossterm"]

README.md

@@ -1,4 +1,5 @@
 # Material
+
 A material design color palette for the terminal
 
 <img src="https://i.ibb.co/2MDKmh7/Screenshot-2022-08-02-at-16-43-12.png" alt="drawing" width="400"/>
@@ -17,12 +18,41 @@ brew install material
 First, install [Rust](https://www.rust-lang.org/tools/install) (using the recommended `rustup` installation method) and then
 
 ```bash
-cargo install material
+cargo install material --locked --features=cli
 ```
 
 ## Usage
 
 Run the command ``material`` in the terminal.
 Type the color code to copy its hex color to the clipboard. Type Esc to exit.
 
+## As a library
+
+This crate can also be used as a library in your own apps.
+
+```bash
+cargo add material
+```
+
+```rust
+use material_colors::colors;
+
+assert_eq!(colors::RED_50.to_string(), "#ffebee");
+assert_eq!(colors::RED_100.to_string(), "#ffcdd2");
+```
 
+### From Ratatui
+
+Colors provided by the library can be converted to [Ratatui](https://ratatui.rs) colors. Just
+enable the `ratatui` feature.
+
+```bash
+cargo add material --features=ratatui
+```
+
+```rust
+use material_colors::colors;
+use ratatui::prelude::*;
+
+let line = Line::styled("hello world", Style::new().fg(colors::RED_50.into()));
+```

src/app.rs

@@ -36,7 +36,7 @@ impl App {
             color.iter().for_each(|color_variant| {
                 if color_variant.0.to_lowercase() == self.input.to_lowercase() {
                     let mut ctx: ClipboardContext = ClipboardProvider::new().unwrap();
-                    ctx.set_contents(color_variant.1.to_owned()).unwrap();
+                    ctx.set_contents(color_variant.1.to_string()).unwrap();
                     self.message = format!("{} copied to clipboard!", color_variant.1);
                 }
             })