Merge branch 'main' of github.com:PatrickLerner/escrit

Cargo.toml

@@ -13,7 +13,7 @@ repository = "https://github.com/PatrickLerner/escrit"
 keywords = ["language-learning", "language"]
 
 [dependencies]
-ratatui = { version = "0.26", features = ["unstable-rendered-line-info"] }
+ratatui = { version = "0.27", features = ["unstable-rendered-line-info"] }
 crossterm = "0.27"
 anyhow = "1.0"
 itertools = "0.13"
@@ -22,7 +22,7 @@ serde = { version = "1.0", features = ["derive"] }
 serde_yaml = "0.9"
 open = "5.1.4"
 app_dirs2 = "2.5"
-clap = { version = "4.5.7", features = ["derive"] }
+clap = { version = "4.5.8", features = ["derive"] }
 tts = "0.26.1"
 libc = "0.2"
 

README.md

@@ -15,9 +15,12 @@ Ukrainian as no config options are provided currently to change this).
 
 ![](https://raw.githubusercontent.com/PatrickLerner/escrit/main/assets/screenshot.png)
 
-## Run
+## Install & Usages
 
-`cargo run -- %file` to open a file in reading mode.
+You can find the package on crates.io and can install it as `cargo install escrit`. Then you can run it like so:
+
+- `escrit text.txt`
+- `pbpaste | escrit` (macos to read clipboard input)
 
 ## Keys / Usages
 
@@ -51,3 +54,4 @@ be in the `escrit` directory.
 ## Dev Notes
 
 - Open line coverage of tests: `cargo llvm-cov --open`
+- While developing you can run it as `cargo run -- %file` to open a file in reading mode.