Skip to content

Commit

Permalink
Adds module section to README (#267)
Browse files Browse the repository at this point in the history
* Update README.md

* Adds Freestyle header image for Readme

* Update README.md

- Adds the header image into the Readme html
- Fixed an URL linking to Monix documentation

* Update README.md

Adds an alt to the image

* Update README.md
  • Loading branch information
raulraja committed May 2, 2017
1 parent 421416a commit b93581f
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
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 efficient data access from heterogenous datasources.

+ [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 in memory and redis based implementations.

+ http - Adapters and marshallers 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/).

## 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.

0 comments on commit b93581f

Please sign in to comment.