Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make require easier, mention adapter registration #5

Closed
wants to merge 4 commits into from
Closed

make require easier, mention adapter registration #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
18541ce
add lib/faraday-typhoeus.rb for easier require
jethrodaniel Nov 4, 2022
9a8dc05
mention adapter registration in README
jethrodaniel Nov 4, 2022
18825eb
disable Style/FileName for the entrypoint file
jethrodaniel Nov 8, 2022
b3bb52c
add a frozen_string_literal
jethrodaniel Nov 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .rubocop.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ AllCops:
TargetRubyVersion: 2.6
SuggestExtensions: false

Naming/FileName:
Exclude:
- lib/faraday-typhoeus.rb

Metrics/BlockLength:
Exclude:
- spec/**/*.rb
Expand Down
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ Or install it yourself as:

## Usage

In order to register the adapter with Faraday, make sure you've required this gem first:
```ruby
require 'faraday-typhoeus'
```

### Basic

```ruby
Expand Down
3 changes: 3 additions & 0 deletions lib/faraday-typhoeus.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# frozen_string_literal: true

require_relative 'faraday/typhoeus'