diff options
author | Kazuki Yamaguchi <k@rhe.jp> | 2015-07-14 23:58:23 +0900 |
---|---|---|
committer | Kazuki Yamaguchi <k@rhe.jp> | 2015-07-14 23:58:23 +0900 |
commit | 75eedc98c39feebbdf6963497a0dbb18e0bf9536 (patch) | |
tree | a53824af5e59fe34a4e6875748849f591ab91c54 /README.md | |
parent | 6c633ec74b71c997a69dda72d9c305b7f31a19c1 (diff) | |
download | plum-75eedc98c39feebbdf6963497a0dbb18e0bf9536.tar.gz |
clean up
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 41 |
1 files changed, 4 insertions, 37 deletions
@@ -1,41 +1,8 @@ # Plum +A minimal implementation of HTTP/2 server. -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/plum`. To experiment with that code, run `bin/console` for an interactive prompt. - -TODO: Delete this and the text above, and describe your gem - -## Installation - -Add this line to your application's Gemfile: - -```ruby -gem 'plum' -``` - -And then execute: - - $ bundle - -Or install it yourself as: - - $ gem install plum - -## Usage - -TODO: Write usage instructions here - -## Development - -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. - -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). - -## Contributing - -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/plum. - +## Requirements +Ruby 2.2 with [ALPN support patch](https://gist.github.com/rhenium/b1711edcc903e8887a51). HTTP/2 requires ALPN. ## License - -The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). - +MIT License |