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.

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

Adds module section to README #267

Merged
merged 6 commits into from
May 2, 2017
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

[comment]: # (End Badges)

A Cohesive & Pragmatic Framework of FP centric Scala libraries
<img src="docs/src/main/resources/microsite/img/freestyle_header.png" alt="A Cohesive & Pragmatic Framework of FP centric Scala libraries" width="100%"/>

# Build purely functional applications and libraries
Build stack-safe purely functional applications and libraries that support parallel and sequential computations where declaration is decoupled from interpretation.
Expand Down Expand Up @@ -68,6 +68,30 @@ def loadUser[F[_]]
}
```

## Modules

+ [freestyle](http://frees.io/docs/) - Core module including building blocks for boilerplate free FP programs and apps over Free monads and cats.

+ [tagless](http://frees.io/docs/core/tagless/) - An alternative encoding to Free based on Tagless Final.

+ [effects](http://frees.io/docs/effects/) - MTL style effects such as reader, writer, state, error, and more modeled as free algebras.

+ [fetch](http://frees.io/docs/integrations/fetch/) - Integration with the Fetch library for effitient data access from heterogenous datasources.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"effitient" -> "efficient"


+ [fs2](http://frees.io/docs/integrations/fs2/) - Integration to run fs2 Streams in Freestyle programs.

+ [monix](http://frees.io/docs/integrations/monix/) - Instances and utilities to interpret to `monix.eval.Task`.

+ [logging](http://frees.io/docs/patterns/logging/) - A purely functional logging algebra over Verizon's Journal.

+ [slick](http://frees.io/docs/integrations/slick/) - Embedding of DBIO actions in Freestyle programs.

+ [doobie](http://frees.io/docs/integrations/doobie/) - Embedding of Doobie ConnectionIO actions in Freestyle programs.

+ [cache](http://frees.io/docs/effects/Cache/) - A generic cache with an in memory and redis based implementations.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Either "with an in memory and a redis based implementation" or "with in memory and redis based implementations"


+ http - Adapters and marshalers to run the Freestyle program in endpoint return types for [akka-http](http://frees.io/docs/integrations/akkahttp/), [finch](http://frees.io/docs/integrations/finch/), [http4s](http://frees.io/docs/integrations/http4s/) and [play](http://frees.io/docs/integrations/play/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

marshaler -> marshaller


## Freestyle in the wild

If you wish to add your library here please consider a PR to include it in the list below.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.