README.md in pastel-cli-0.3.0 vs README.md in pastel-cli-0.4.0

- old
+ new

@@ -1,26 +1,25 @@ # Pastel CLI + [![Gem Version](https://badge.fury.io/rb/pastel-cli.svg)][gem] [![Build Status](https://secure.travis-ci.org/piotrmurach/pastel-cli.svg?branch=master)][travis] -[![Code Climate](https://codeclimate.com/github/piotrmurach/pastel-cli/badges/gpa.svg)][codeclimate] -[![Coverage Status](https://coveralls.io/repos/github/piotrmurach/pastel-cli/badge.svg)][coverage] +[![Build status](https://ci.appveyor.com/api/projects/status/lqhbd9sy4rn8xdr2?svg=true)][appveyor] [gem]: http://badge.fury.io/rb/pastel-cli [travis]: http://travis-ci.org/piotrmurach/pastel-cli -[codeclimate]: https://codeclimate.com/github/piotrmurach/pastel-cli -[coverage]: https://coveralls.io/github/piotrmurach/pastel-cli +[appveyor]: https://ci.appveyor.com/project/piotrmurach/pastel-cli > CLI tool for intuitive terminal output styling **Pastel CLI** provides terminal tool for [Pastel](https://github.com/piotrmurach/pastel). ## Installation Add this line to your application's Gemfile: ```ruby -gem 'pastel-cli' +gem "pastel-cli" ``` And then execute: $ bundle @@ -29,34 +28,55 @@ $ gem install pastel-cli ## Usage -To color output in green issue the command: +To color output in green do: ```bash -$ pastel green 'Unicorns & rainbows!' +$ pastel green " ✔ OK " ``` -You can also provide more than one styling option: +Apart from foreground color, you can also provide background and style like so: ```bash -$ pastel green on_red bold 'Unicorns & rainbows!' +$ pastel black bold on_green " ✔ OK " ``` -Pipe input: +It supports pipping input: ```bash -$ echo 'Unicorns & rainbows!' | pastel green +$ echo -n " ✔ OK " | pastel black bold on_green ``` +To see all available styles and color names use `--styles/-s` option: + +```bash +$ pastel --styles +``` + +This will produce the following in the terminal: + +```bash +Swatch Name +◼ pastel bold +◼ pastel dark +◼ pastel dim +◼ pastel italic +... +``` + ## Contributing 1. Fork it ( https://github.com/piotrmurach/pastel-cli/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create a new Pull Request +## Code of Conduct + +Everyone interacting in the Pastel CLI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/tty-option/blob/master/CODE_OF_CONDUCT.md). + ## Copyright -Copyright (c) 2016-2017 Piotr Murach. See LICENSE for further details. +Copyright (c) 2016 Piotr Murach. See LICENSE for further details.