diff --git a/README.md b/README.md new file mode 100644 index 0000000..4acc3fe --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +uh-wm +===== + + Xlib Window Manager prototype. + +[![Version ][badge-version-img]][badge-version-uri] +[![Build status ][badge-build-img]][badge-build-uri] +[![Code Climate ][badge-cclimate-img]][badge-cclimate-uri] + + +Getting started +--------------- + +### Installation (requires ruby ~> 2.1 and rubygems) + +``` +$ gem install uh-wm +``` + + +### Usage + +``` +Usage: uhwm [options] + +options: + -h, --help print this message +``` + + + +[badge-version-img]: https://img.shields.io/gem/v/uh-wm.svg?style=flat-square +[badge-version-uri]: https://rubygems.org/gems/uh-wm +[badge-build-img]: https://img.shields.io/travis/tjouan/uh-wm/master.svg?style=flat-square +[badge-build-uri]: https://travis-ci.org/tjouan/uh-wm +[badge-cclimate-img]: https://img.shields.io/codeclimate/github/tjouan/uh-wm.svg?style=flat-square +[badge-cclimate-uri]: https://codeclimate.com/github/tjouan/uh-wm