Allow for copy paste to work #760
Conversation
Eliminate the "$" executing bundle
|
The README contains a mixture of both shell and Ruby code examples. Including the prompts helps visually disambiguate which ones are which, even if it makes copy/paste slightly harder. Also, there are multiple shell examples and this proposal only covers one of them, so at best it's inconsistent. |
|
I find it's better to have This section is also pretty standard, as it's the default README of gem skeleton provided by bundler. With that being said, I do think it's better to let shell commands to standout from ruby code. Removing |
|
We can update it to be smaller, though. I believe people working with Ruby know what Gemfile is and how to modify it manually. Thus, we can follow the latest bundler's template, that is all that will be good for all users: ## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add http
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install httpThen we can update Usage section a bit: ## Usage
``` ruby
require "http"
response = HTTP.get("https://github.com")
# => #<HTTP::Response/1.1 200 OK {"Server"=>"GitHub.com", "Date"=>"Tue, 10 May...
# Get response body as a String
HTTP.get("https://github.com").to_s
# => "\n\n\n<!DOCTYPE html>\n<html lang=\"en\" class=\"\">\n <head prefix=\"o...
# Get response body object for streaming
body = HTTP.get("https://github.com").body
File.new("/tmp/example.html", "w") do |io|
while chunk = body.readpartial
io << chunk
end
end
```
See [wiki][documentation] for more detailed documentation and usage notes.
The following API documentation is also available:
- [YARD API documentation](https://www.rubydoc.info/github/httprb/http)
- [Chainable module (all chainable methods)](https://www.rubydoc.info/github/httprb/http/HTTP/Chainable) |
Eliminate the "$" executing bundle