Rename project (#26)

* Change name to "tealdeer"
* Rename repository as well
* Add logo
This commit is contained in:
Danilo Bargen 2016-04-16 10:20:16 +02:00
commit 6398f6594f
7 changed files with 76 additions and 14 deletions

View file

@ -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] <command>
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: