diff --git a/README.md b/README.md index b90a55a75d0fdd6784f3c7c96d2352ece1ab9316..4e1fb0bd588979ec44974c70adb82493758821d1 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,49 @@ This project uses Cargo and Rust Stable ```bash cargo build --release ``` + +## Example +``rust +extern crate rustyline; + +use rustyline::error::ReadlineError; +use rustyline::Editor; + +fn main() { + let mut rl = Editor::new(); + if let Err(_) = rl.load_history("history.txt") { + println!("No previous history."); + } + loop { + let readline = rl.readline(">> "); + match readline { + Ok(line) => { + rl.add_history_entry(&line); + println!("Line: {}", line); + }, + Err(ReadlineError::Interrupted) => { + println!("CTRL-C"); + break + }, + Err(ReadlineError::Eof) => { + println!("CTRL-D"); + break + }, + Err(err) => { + println!("Error: {:?}", err); + break + } + } + } + rl.save_history("history.txt").unwrap(); +} +``` + +## crates.io +You can use this package in your project by adding the following +to your `Cargo.toml`: + +``toml +[dependencies] +rustyline = "0.1.0" +```