From f391b974eaaebc412fe36e5741bc5bc882943bce Mon Sep 17 00:00:00 2001 From: Danilo Bargen Date: Sun, 3 Jan 2016 23:50:49 +0100 Subject: [PATCH] Add goals to README --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index a0c1eeb..6b9cbcb 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,14 @@ An implementation of [tldr](https://github.com/tldr-pages/tldr) in Rust. +Project goals: + +- [x] Don't require a network connection for anything besides updating the cache +- [x] Render tldr pages to ANSI terminals +- [x] Download and cache pages, compatible to the [NodeJS client][tldr-node-client] +- [ ] Command line interface similar or equivalent to the [NodeJS client][tldr-node-client] +- [x] Be fast + ## Building Debug build with logging enabled: @@ -21,3 +29,6 @@ To enable the log output, set the `RUST_LOG` env variable: ## License MIT + + +[tldr-node-client]: https://github.com/tldr-pages/tldr-node-client