mirror of
https://github.com/lostisland/faraday.git
synced 2025-10-05 00:05:35 -04:00
56 lines
2.6 KiB
Markdown
56 lines
2.6 KiB
Markdown
# [][website]
|
|
|
|
[](https://rubygems.org/gems/faraday)
|
|
|
|
[](https://codeclimate.com/github/lostisland/faraday/test_coverage)
|
|
[](https://codeclimate.com/github/lostisland/faraday/maintainability)
|
|
[](https://gitter.im/lostisland/faraday?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
|
|
|
|
|
Faraday is an HTTP client library that provides a common interface over many
|
|
adapters (such as Net::HTTP) and embraces the concept of Rack middleware when
|
|
processing the request/response cycle.
|
|
|
|
## Getting Started
|
|
|
|
The best starting point is the [Faraday Website][website], with its introduction and explanation.
|
|
Need more details? See the [Faraday API Documentation][apidoc] to see how it works internally.
|
|
|
|
## Supported Ruby versions
|
|
|
|
This library aims to support and is [tested against][actions] the following Ruby
|
|
implementations:
|
|
|
|
* Ruby 2.4+
|
|
|
|
If something doesn't work on one of these Ruby versions, it's a bug.
|
|
|
|
This library may inadvertently work (or seem to work) on other Ruby
|
|
implementations and versions, however support will only be provided for the versions listed
|
|
above.
|
|
|
|
If you would like this library to support another Ruby version, you may
|
|
volunteer to be a maintainer. Being a maintainer entails making sure all tests
|
|
run and pass on that implementation. When something breaks on your
|
|
implementation, you will be responsible for providing patches in a timely
|
|
fashion. If critical issues for a particular implementation exist at the time
|
|
of a major release, support for that Ruby version may be dropped.
|
|
|
|
## Contribute
|
|
|
|
Do you want to contribute to Faraday?
|
|
Open the issues page and check for the `help wanted` label!
|
|
But before you start coding, please read our [Contributing Guide][contributing]
|
|
|
|
## Copyright
|
|
© 2009 - 2019, the [Faraday Team][faraday_team]. Website and branding design by [Elena Lo Piccolo](https://elelopic.design).
|
|
|
|
[website]: https://lostisland.github.io/faraday
|
|
[faraday_team]: https://lostisland.github.io/faraday/team
|
|
[contributing]: https://github.com/lostisland/faraday/blob/master/.github/CONTRIBUTING.md
|
|
[apidoc]: http://www.rubydoc.info/gems/faraday
|
|
[actions]: https://github.com/lostisland/faraday/actions
|
|
[jruby]: http://jruby.org/
|
|
[rubinius]: http://rubini.us/
|
|
[license]: LICENSE.md
|