Repository files navigation

Featherbed aims to be a typesafe, functional REST client API overFinagle.It provides a friendlier approach to building REST client interfaces in Scala. Currently, Featherbedis in the early stages of development, and includes the following modules:

1. featherbed-core - the functional client interface
2. featherbed-circe - automatic JSON request encoding and response decoding usingcirce

The following modules are planned:

1. featherbed-oauth - OAuth authenticated requests

To get started with featherbed, check out theGuide.

Featherbed aims to have a minimal set of dependencies. Besidesfinagle-http, the core project isdependent only onshapeless andcats.

featherbed-circe depends additionall oncirce

Featherbed is licensed under theApache License, Version 2.0(the "License"); you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specificlanguage governing permissions and limitations under the License.

As of the latest build of featherbed,

• Finagle is licensed under theApache License, Version 2.0
• shapeless is licensed under theApache License, Version 2.0
• cats is licensed under theMIT License
• circe is licensed under theApache License, Version 2.0

Featherbed is an independent project, and is neither governed nor endorsed by any of the above projects. All uses ofthe above projects by featherbed are within those allowed by each respective project's license. Any software usingone of the above projects, even as a dependency of featherbed, must also abide by that project's license in addition tofeatherbed's.