vendor/github.com/bgentry/speakeasy/Readme.md

   1 # Speakeasy
   2
   3 This package provides cross-platform Go (#golang) helpers for taking user input
   4 from the terminal while not echoing the input back (similar to `getpasswd`). The
   5 package uses syscalls to avoid any dependence on cgo, and is therefore
   6 compatible with cross-compiling.
   7
   8 [![GoDoc](https://godoc.org/github.com/bgentry/speakeasy?status.png)][godoc]
   9
  10 ## Unicode
  11
  12 Multi-byte unicode characters work successfully on Mac OS X. On Windows,
  13 however, this may be problematic (as is UTF in general on Windows). Other
  14 platforms have not been tested.
  15
  16 ## License
  17
  18 The code herein was not written by me, but was compiled from two separate open
  19 source packages. Unix portions were imported from [gopass][gopass], while
  20 Windows portions were imported from the [CloudFoundry Go CLI][cf-cli]'s
  21 [Windows terminal helpers][cf-ui-windows].
  22
  23 The [license for the windows portion](./LICENSE_WINDOWS) has been copied exactly
  24 from the source (though I attempted to fill in the correct owner in the
  25 boilerplate copyright notice).
  26
  27 [cf-cli]: https://github.com/cloudfoundry/cli "CloudFoundry Go CLI"
  28 [cf-ui-windows]: https://github.com/cloudfoundry/cli/blob/master/src/cf/terminal/ui_windows.go "CloudFoundry Go CLI Windows input helpers"
  29 [godoc]: https://godoc.org/github.com/bgentry/speakeasy "speakeasy on Godoc.org"
  30 [gopass]: https://code.google.com/p/gopass "gopass"