ceos/tealdeer
1
0
Fork 0
mirror of https://github.com/tealdeer-rs/tealdeer.git synced 2026-08-09 09:49:10 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add goals to README

Browse source
This commit is contained in:
Danilo Bargen 2016-01-03 23:50:49 +01:00
commit f391b974ea
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -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