README.md

   1 # Tutil
   2
   3 [![Travis CI][travis-ci-badge]][travis-ci]
   4 [![Coveralls][coveralls-badge]][coveralls]
   5 [![Crates.io][crates-io-badge]][crates-io]
   6 [![Gitter][gitter-badge]][gitter]
   7 [![License][license-badge]][license]
   8
   9 Tutil is a toolbox for developing command line applications in Rust, influenced
  10 by the [TTY library][tty] for Ruby which intends to reach feature parity with
  11 the majority of TTY's features to the extent that is practical in addition to
  12 having an extensive and thorough test suite.
  13
  14 The documentation can by accessed on my [website](https://shrike.me/tutil).
  15
  16 ## Features
  17
  18 Implemented features will be marked with a tick (✔) and unimplemented features
  19 will be marked with a cross (✗).
  20
  21 - Terminal output colourisation. ✔
  22 - Terminal output paging. ✗
  23 - Terminal ASCII and Unicode tables. ✗
  24 - System detection utilities. ✗
  25 - Command detection utilities. ✗
  26 - Text manipulation (wrapping and truncation). ✗
  27 - Terminal progress bars. ✗
  28 - Terminal spinners. ✗
  29 - User input prompts. ✗
  30 - Windows support. ✗
  31
  32 ## Installation
  33
  34 Add the following to your `Cargo.toml` under the dependencies section:
  35
  36 ```toml
  37 [dependencies]
  38 tutil = "^0.1.0"
  39 ```
  40
  41 <!-- Links -->
  42 [tty]: http://peter-murach.github.io/tty/
  43 <!-- Badge links and SVGs -->
  44 [travis-ci]: https://travis-ci.org/SShrike/tutil
  45 [travis-ci-badge]: https://img.shields.io/travis/SShrike/tutil.svg
  46 [coveralls]: https://coveralls.io/github/SShrike/tutil
  47 [coveralls-badge]: https://img.shields.io/coveralls/SShrike/tutil.svg
  48 [crates-io]: https://crates.io/crates/tutil
  49 [crates-io-badge]: https://img.shields.io/crates/v/tutil.svg
  50 [gitter]: https://gitter.im/SShrike/tutil
  51 [gitter-badge]: https://img.shields.io/gitter/room/SShrike/tutil.svg
  52 [license]: https://www.mozilla.org/en-GB/MPL/2.0/
  53 [license-badge]: https://img.shields.io/crates/l/tutil.svg