README.md in userinput-1.0.0 vs README.md in userinput-1.0.1

- old
+ new

@@ -1,13 +1,13 @@ userinput ========= [![Gem Version](https://img.shields.io/gem/v/userinput.svg)](https://rubygems.org/gems/userinput) [![Dependency Status](https://img.shields.io/gemnasium/akerl/userinput.svg)](https://gemnasium.com/akerl/userinput) -[![Code Climate](https://img.shields.io/codeclimate/github/akerl/userinput.svg)](https://codeclimate.com/github/akerl/userinput) -[![Coverage Status](https://img.shields.io/coveralls/akerl/userinput.svg)](https://coveralls.io/r/akerl/userinput) -[![Build Status](https://img.shields.io/travis/akerl/userinput.svg)](https://travis-ci.org/akerl/userinput) +[![Build Status](https://img.shields.io/circleci/project/akerl/userinput.svg)](https://circleci.com/gh/akerl/userinput) +[![Coverage Status](https://img.shields.io/codecov/c/github/akerl/userinput.svg)](https://codecov.io/github/akerl/userinput) +[![Code Quality](https://img.shields.io/codacy/fbda4046154e4ac38a47f2c6627d57c8.svg)](https://www.codacy.com/app/akerl/userinput) [![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license) A simple user input library ## Usage @@ -78,9 +78,21 @@ ``` > require 'userinput' => true > prompt = UserInput.new(message: 'Password', secret: true) => #<UserInput::Prompt:0x007fb8ab9220a0 @attempts=nil, @message="Password", @default=nil, @secret=true, @validation=nil> +> prompt.ask +Password? +=> "_password" +``` + +Setting the file descriptor lets you control where output is sent (for instance, use this to print messages on STDERR or to a custom IO object): + +``` +> require 'userinput' +=> true +> prompt = UserInput.new(message: 'Password', secret: true, fd: STDERR) +=> #<UserInput::Prompt:0x007f888110a138 @attempts=nil, @message="Password", @default=nil, @secret=true, @fd=#<IO:<STDERR>>, @validation=nil> > prompt.ask Password? => "_password" ```