Skip to content

Commit d72c24a

Browse files
readme update
1 parent 994d487 commit d72c24a

File tree

1 file changed

+2
-20
lines changed

1 file changed

+2
-20
lines changed

README.md

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,15 @@
11
# HyperRuby
22

3-
A very fast HTTP server for Ruby; uses th
3+
A very niche, fast HTTP server for Ruby, but not intended for general-purpose use.
44

5-
## Installation
6-
7-
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
8-
9-
Install the gem and add to the application's Gemfile by executing:
10-
11-
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
12-
13-
If bundler is not being used to manage dependencies, install the gem by executing:
14-
15-
$ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
16-
17-
## Usage
18-
19-
TODO: Write usage instructions here
5+
It's not compatible with rack or rails. You probably don't want to use it if you're after a general-purpose web server for your app.
206

217
## Development
228

239
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
2410

2511
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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
2612

27-
## Contributing
28-
29-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hyper_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/hyper_ruby/blob/master/CODE_OF_CONDUCT.md).
30-
3113
## License
3214

3315
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)