diff --git a/Cargo.lock b/Cargo.lock index d24bf88..23e1cce 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1,5 +1,5 @@ [root] -name = "tldr" +name = "tealdeer" version = "0.1.0" dependencies = [ "ansi_term 0.7.2 (registry+https://github.com/rust-lang/crates.io-index)", diff --git a/Cargo.toml b/Cargo.toml index 3171720..82c5f6d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,13 +1,17 @@ [package] -name = "tldr" -version = "0.1.0" +name = "tealdeer" +version = "0.2.0" authors = ["Danilo Bargen "] -repository = "https://github.com/dbrgn/tldr-rs/" -homepage = "https://github.com/dbrgn/tldr-rs/" +repository = "https://github.com/dbrgn/tealdeer/" +homepage = "https://github.com/dbrgn/tealdeer/" license = "MIT/Apache-2.0" readme = "README.md" description = "Fetch and show tldr help pages for many CLI commands. Full featured offline client with caching support." +[[bin]] +name = "tldr" +path = "src/main.rs" + [features] logging = ["env_logger"] dev = ["clippy"] diff --git a/README.md b/README.md index a096d6a..79ab9c7 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,15 @@ -# tldr-rs +# tealdeer -[![Build status](https://img.shields.io/travis/dbrgn/tldr-rs/master.svg)](https://travis-ci.org/dbrgn/tldr-rs) +![teal deer](deer.png) + +[![Build status](https://img.shields.io/travis/dbrgn/tealdeer/master.svg)](https://travis-ci.org/dbrgn/tealdeer) An implementation of [tldr](https://github.com/tldr-pages/tldr) in Rust. +If you pronounce "tldr" in English, it sounds somewhat like "tealdeer". Hence the project name :) + +## Goals + High level project goals: - [x] Download and cache pages @@ -11,7 +17,7 @@ High level project goals: - [x] Command line interface similar or equivalent to the [NodeJS client][tldr-node-client] - [x] Be fast -Usage: +## Usage tldr [options] tldr [options] @@ -47,12 +53,12 @@ Build and install the tool from source (see section "Building" in this README). If you're an Arch Linux user, you can also install the package from the AUR: - $ yaourt -S tldr-rs-git + $ yaourt -S tealdeer-git ## Building -tldr-rs requires at least Rust 1.6. +tealdeer requires at least Rust 1.6. Debug build with logging enabled: diff --git a/deer.png b/deer.png new file mode 100644 index 0000000..ebc9c9d Binary files /dev/null and b/deer.png differ diff --git a/deer.svg b/deer.svg new file mode 100644 index 0000000..b686b4b --- /dev/null +++ b/deer.svg @@ -0,0 +1,52 @@ + + + + + + image/svg+xml + + + + + + + + diff --git a/src/cache.rs b/src/cache.rs index a8905f6..f156f7a 100644 --- a/src/cache.rs +++ b/src/cache.rs @@ -46,11 +46,11 @@ impl Cache { } }; - // Otherwise, fall back to ~/.cache/tldr-rs + // Otherwise, fall back to ~/.cache/tealdeer let home_dir = try!(env::home_dir().ok_or( CacheError("Could not determine home directory".into()) )); - Ok(home_dir.join(".cache").join("tldr-rs")) + Ok(home_dir.join(".cache").join("tealdeer")) } /// Download the archive diff --git a/src/main.rs b/src/main.rs index 8a433eb..c615310 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,6 +1,6 @@ //! An implementation of [tldr](https://github.com/tldr-pages/tldr) in Rust. // -// Copyright (c) 2015-2016 tldr-rs developers +// Copyright (c) 2015-2016 tealdeer developers // // Licensed under the Apache License, Version 2.0 or the MIT license @@ -54,7 +54,7 @@ use formatter::print_lines; use types::OsType; -const NAME: &'static str = "tldr-rs"; +const NAME: &'static str = "tealdeer"; const VERSION: &'static str = env!("CARGO_PKG_VERSION"); const USAGE: &'static str = " Usage: