README.md in okay-2.0.0 vs README.md in okay-3.0.0
- old
+ new
@@ -6,12 +6,11 @@
Goals:
* Concise, but easy-to-understand code.
* Be reasonably robust, but don't chase every potential edgecase. Handle
- them as they come, and try to find a way to the code easy to
- understand.
+ them as they come.
* Well-documented codebase.
* Document known limitations, not just features.
* Document tests, not just the implementation.
* Thorough, easily-understood tests.
@@ -21,21 +20,10 @@
or ask questions if you aren't sure it'll work for your usecase.
If it doesn't, I may decide I want to add support for it, or be able to
help you find something that works for you!
-## Utilities
-
-Currently implemented utilities:
-
-* HTTP fetcher.
- * `GET` requests implemented.
- * `POST` requests implemented.
- * Other types of requests should be fairly easy to add, but haven't
- been added.
- * TLS is supported, using [`openssl/better_defaults`](https://github.com/duckinator/openssl-better_defaults/) to improve security on old Ruby versions.
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -51,9 +39,14 @@
$ gem install okay
## Usage
### HTTP
+
+* `GET` and `POST` requests supported.
+* TLS is supported, using [`openssl/better_defaults`](https://github.com/duckinator/openssl-better_defaults/) to improve security on old Ruby versions.
+* Does not handle HTTP 307 redirects correctly. (Because it changes it to a GET
+ request.)
```ruby
require 'okay/http'
Okay::HTTP.get("https://smallest.dog") #=> #<Net::HTTPOK 200 OK readbody=true>