diff --git a/README.md b/README.md index 9ee2d23..6b7f705 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,15 @@ -# Witchcraft ![](./logo.png) +Functors, monads, arrows, and categories + | Build Status | Maintainer Message | Documentation | Hosted Package | |--------------|--------------------|---------------|----------------| | [![Circle CI](https://circleci.com/gh/robot-overlord/witchcraft/tree/master.svg?style=svg)](https://circleci.com/gh/robot-overlord/witchcraft/tree/master) | ![built with humanity](https://cloud.githubusercontent.com/assets/1052016/11023213/66d837a4-8627-11e5-9e3b-b295fafb1450.png) |[robotoverlord.io/witchcraft](http://www.robotoverlord.io/witchcraft/extra-readme.html) | [Hex](https://hex.pm/packages/witchcraft) | -A monoid, functor, applicative, monad, and arrow library - -*This is currently very Haskell-flavoured*. It will become more idiomatic after the first pass. - -## Installation - -1. Add witchcraft to your list of dependencies in `mix.exs`: +# Quick Start ``` def deps do [{:witchcraft, "~> 0.2.0"}] end ``` - -2. Ensure witchcraft is started before your application: - -``` -def application do - [applications: [:witchcraft]] -end -```