Skip to content
This repository has been archived by the owner on Jul 25, 2018. It is now read-only.

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@stoeffel
stoeffel committed Feb 16, 2016
1 parent bc068da commit 6400bd5
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 60 deletions.
103 changes: 51 additions & 52 deletions README.md
View file
Expand Up @@ -10,10 +10,9 @@ Every thing for your combinatory needs.

Check out the [docs](#ornithology) to see all available birds.

[![Build Status](https://travis-ci.org/stoeffel/fantasy-birds.svg)](https://travis-ci.org/stoeffel/fantasy-birds)
[![Build Status](https://travis-ci.org/fantasyland/fantasy-birds.svg)](https://travis-ci.org/fantasyland/fantasy-birds)
[![npm version](https://badge.fury.io/js/fantasy-birds.svg)](http://badge.fury.io/js/fantasy-birds)
[![dependecies](https://david-dm.org/stoeffel/fantasy-birds.svg)](https://david-dm.org/stoeffel/fantasy-birds.svg)
[![codecov.io](https://codecov.io/github/stoeffel/fantasy-birds/coverage.svg?branch=master)](https://codecov.io/github/stoeffel/fantasy-birds?branch=master)
[![dependecies](https://david-dm.org/fantasyland/fantasy-birds.svg)](https://david-dm.org/fantasyland/fantasy-birds.svg)

[docs]: ./DOCS.md
[haskell-docs]: https://hackage.haskell.org/package/data-aviary-0.4.0/docs/Data-Aviary-Birds.html
Expand All @@ -23,7 +22,7 @@ Check out the [docs](#ornithology) to see all available birds.
## Ornithology


<h3 name="idiot"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L1">idiot :: a -> a</a></code></h3>
<h3 name="idiot"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L1">idiot :: a -> a</a></code></h3>

identity

Expand All @@ -32,7 +31,7 @@ identity
'bird'
```

<h3 name="kestrel"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L11">kestrel :: a -> b -> a</a></code></h3>
<h3 name="kestrel"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L11">kestrel :: a -> b -> a</a></code></h3>

K combinator or `const`

Expand All @@ -41,7 +40,7 @@ K combinator or `const`
'bird'
```

<h3 name="bluebird"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L21">bluebird :: (b -> c) -> (a -> b) -> a -> c</a></code></h3>
<h3 name="bluebird"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L21">bluebird :: (b -> c) -> (a -> b) -> a -> c</a></code></h3>

B combinator or function composition

Expand All @@ -50,7 +49,7 @@ B combinator or function composition
4
```

<h3 name="cardinal"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L31">cardinal :: (a -> b -> c) -> b -> a -> c</a></code></h3>
<h3 name="cardinal"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L31">cardinal :: (a -> b -> c) -> b -> a -> c</a></code></h3>

C combinator or flip

Expand All @@ -59,7 +58,7 @@ C combinator or flip
'-birds'
```

<h3 name="applicator"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L41">applicator :: (a -> b) -> a -> b</a></code></h3>
<h3 name="applicator"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L41">applicator :: (a -> b) -> a -> b</a></code></h3>

A combinator or apply

Expand All @@ -68,7 +67,7 @@ A combinator or apply
4
```

<h3 name="psi"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L51">psi :: (b -> b -> c) -> (a -> b) -> a -> a -> c</a></code></h3>
<h3 name="psi"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L51">psi :: (b -> b -> c) -> (a -> b) -> a -> a -> c</a></code></h3>

PSI combinator or on

Expand All @@ -77,7 +76,7 @@ PSI combinator or on
-8
```

<h3 name="becard"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L61">becard :: (c -> d) -> (b -> c) -> (a -> b) -> a -> d</a></code></h3>
<h3 name="becard"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L61">becard :: (c -> d) -> (b -> c) -> (a -> b) -> a -> d</a></code></h3>

B3 combinator or function composition (for three functions)

Expand All @@ -86,7 +85,7 @@ B3 combinator or function composition (for three functions)
-4
```

<h3 name="blackbird"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L71">blackbird :: (c -> d) -> (a -> b -> c) -> a -> b -> d</a></code></h3>
<h3 name="blackbird"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L71">blackbird :: (c -> d) -> (a -> b -> c) -> a -> b -> d</a></code></h3>

B1 combinator

Expand All @@ -95,7 +94,7 @@ B1 combinator
-8
```

<h3 name="bluebird_"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L81">bluebird_ :: (a -> c -> d) -> a -> (b -> c) -> b -> d</a></code></h3>
<h3 name="bluebird_"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L81">bluebird_ :: (a -> c -> d) -> a -> (b -> c) -> b -> d</a></code></h3>

B' combinator

Expand All @@ -104,7 +103,7 @@ B' combinator
6
```

<h3 name="bunting"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L91">bunting :: (d -> e) -> (a -> b -> c -> d) -> a -> b -> c -> e</a></code></h3>
<h3 name="bunting"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L91">bunting :: (d -> e) -> (a -> b -> c -> d) -> a -> b -> c -> e</a></code></h3>

B2 combinator

Expand All @@ -113,7 +112,7 @@ B2 combinator
-6
```

<h3 name="cardinal_"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L101">cardinal_ :: (c -> a -> d) -> (b -> c) -> a -> b -> d</a></code></h3>
<h3 name="cardinal_"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L101">cardinal_ :: (c -> a -> d) -> (b -> c) -> a -> b -> d</a></code></h3>

C' combinator

Expand All @@ -122,78 +121,78 @@ C' combinator
8
```

<h3 name="cardinalstar"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L111">cardinalstar :: (a -> c -> b -> d) -> a -> b -> c -> d</a></code></h3>
<h3 name="cardinalstar"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L111">cardinalstar :: (a -> c -> b -> d) -> a -> b -> c -> d</a></code></h3>

<h3 name="cardinalstarstar"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L114">cardinalstarstar :: (a -> b -> d -> c -> e) -> a -> b -> c -> d -> e</a></code></h3>
<h3 name="cardinalstarstar"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L114">cardinalstarstar :: (a -> b -> d -> c -> e) -> a -> b -> c -> d -> e</a></code></h3>

<h3 name="dove"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L117">dove :: (a -> c -> d) -> a -> (b -> c) -> b -> d</a></code></h3>
<h3 name="dove"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L117">dove :: (a -> c -> d) -> a -> (b -> c) -> b -> d</a></code></h3>

<h3 name="dickcissel"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L120">dickcissel :: (a -> b -> d -> e) -> a -> b -> (c -> d) -> c -> e</a></code></h3>
<h3 name="dickcissel"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L120">dickcissel :: (a -> b -> d -> e) -> a -> b -> (c -> d) -> c -> e</a></code></h3>

<h3 name="dovekie"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L123">dovekie :: (c -> d -> e) -> (a -> c) -> a -> (b -> d) -> b -> e</a></code></h3>
<h3 name="dovekie"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L123">dovekie :: (c -> d -> e) -> (a -> c) -> a -> (b -> d) -> b -> e</a></code></h3>

<h3 name="eagle"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L126">eagle :: (a -> d -> e) -> a -> (b -> c -> d) -> b -> c -> e</a></code></h3>
<h3 name="eagle"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L126">eagle :: (a -> d -> e) -> a -> (b -> c -> d) -> b -> c -> e</a></code></h3>

<h3 name="eaglebald"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L129">eaglebald :: (e -> f -> g) -> (a -> b -> e) -> a -> b -> (c -> d -> f) -> c -> d -> g</a></code></h3>
<h3 name="eaglebald"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L129">eaglebald :: (e -> f -> g) -> (a -> b -> e) -> a -> b -> (c -> d -> f) -> c -> d -> g</a></code></h3>

<h3 name="finch"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L132">finch :: a -> b -> (b -> a -> c) -> c</a></code></h3>
<h3 name="finch"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L132">finch :: a -> b -> (b -> a -> c) -> c</a></code></h3>

<h3 name="finchstar"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L135">finchstar :: (c -> b -> a -> d) -> a -> b -> c -> d</a></code></h3>
<h3 name="finchstar"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L135">finchstar :: (c -> b -> a -> d) -> a -> b -> c -> d</a></code></h3>

<h3 name="finchstarstar"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L138">finchstarstar :: (a -> d -> c -> b -> e) -> a -> b -> c -> d -> e</a></code></h3>
<h3 name="finchstarstar"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L138">finchstarstar :: (a -> d -> c -> b -> e) -> a -> b -> c -> d -> e</a></code></h3>

<h3 name="goldfinch"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L141">goldfinch :: (b -> c -> d) -> (a -> c) -> a -> b -> d</a></code></h3>
<h3 name="goldfinch"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L141">goldfinch :: (b -> c -> d) -> (a -> c) -> a -> b -> d</a></code></h3>

<h3 name="hummingbird"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L144">hummingbird :: (a -> b -> a -> c) -> a -> b -> c</a></code></h3>
<h3 name="hummingbird"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L144">hummingbird :: (a -> b -> a -> c) -> a -> b -> c</a></code></h3>

<h3 name="idstar"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L147">idstar :: (a -> b) -> a -> b</a></code></h3>
<h3 name="idstar"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L147">idstar :: (a -> b) -> a -> b</a></code></h3>

<h3 name="idstarstar"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L150">idstarstar :: (a -> b -> c) -> a -> b -> c</a></code></h3>
<h3 name="idstarstar"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L150">idstarstar :: (a -> b -> c) -> a -> b -> c</a></code></h3>

<h3 name="jalt"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L153">jalt :: (a -> c) -> a -> b -> c</a></code></h3>
<h3 name="jalt"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L153">jalt :: (a -> c) -> a -> b -> c</a></code></h3>

<h3 name="jalt_"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L156">jalt_ :: (a -> b -> d) -> a -> b -> c -> d</a></code></h3>
<h3 name="jalt_"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L156">jalt_ :: (a -> b -> d) -> a -> b -> c -> d</a></code></h3>

<h3 name="jay"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L159">jay :: (a -> b -> b) -> a -> b -> a -> b</a></code></h3>
<h3 name="jay"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L159">jay :: (a -> b -> b) -> a -> b -> a -> b</a></code></h3>

<h3 name="kite"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L162">kite :: a -> b -> b</a></code></h3>
<h3 name="kite"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L162">kite :: a -> b -> b</a></code></h3>

<h3 name="owl"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L165">owl :: ((a -> b) -> a) -> (a -> b) -> b</a></code></h3>
<h3 name="owl"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L165">owl :: ((a -> b) -> a) -> (a -> b) -> b</a></code></h3>

<h3 name="phoenix"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L168">phoenix :: (b -> c -> d) -> (a -> b) -> (a -> c) -> a -> d</a></code></h3>
<h3 name="phoenix"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L168">phoenix :: (b -> c -> d) -> (a -> b) -> (a -> c) -> a -> d</a></code></h3>

<h3 name="quacky"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L171">quacky :: a -> (a -> b) -> (b -> c) -> c</a></code></h3>
<h3 name="quacky"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L171">quacky :: a -> (a -> b) -> (b -> c) -> c</a></code></h3>

<h3 name="queer"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L174">queer :: (a -> b) -> (b -> c) -> a -> c</a></code></h3>
<h3 name="queer"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L174">queer :: (a -> b) -> (b -> c) -> a -> c</a></code></h3>

<h3 name="quirky"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L177">quirky :: (a -> b) -> a -> (b -> c) -> c</a></code></h3>
<h3 name="quirky"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L177">quirky :: (a -> b) -> a -> (b -> c) -> c</a></code></h3>

<h3 name="quixotic"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L180">quixotic :: (b -> c) -> a -> (a -> b) -> c</a></code></h3>
<h3 name="quixotic"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L180">quixotic :: (b -> c) -> a -> (a -> b) -> c</a></code></h3>

<h3 name="quizzical"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L183">quizzical :: a -> (b -> c) -> (a -> b) -> c</a></code></h3>
<h3 name="quizzical"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L183">quizzical :: a -> (b -> c) -> (a -> b) -> c</a></code></h3>

<h3 name="robin"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L186">robin :: a -> (b -> a -> c) -> b -> c</a></code></h3>
<h3 name="robin"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L186">robin :: a -> (b -> a -> c) -> b -> c</a></code></h3>

<h3 name="robinstar"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L189">robinstar :: (b -> c -> a -> d) -> a -> b -> c -> d</a></code></h3>
<h3 name="robinstar"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L189">robinstar :: (b -> c -> a -> d) -> a -> b -> c -> d</a></code></h3>

<h3 name="robinstarstar"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L192">robinstarstar :: (a -> c -> d -> b -> e) -> a -> b -> c -> d -> e</a></code></h3>
<h3 name="robinstarstar"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L192">robinstarstar :: (a -> c -> d -> b -> e) -> a -> b -> c -> d -> e</a></code></h3>

<h3 name="starling"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L195">starling :: (a -> b -> c) -> (a -> b) -> a -> c</a></code></h3>
<h3 name="starling"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L195">starling :: (a -> b -> c) -> (a -> b) -> a -> c</a></code></h3>

<h3 name="starling_"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L198">starling_ :: (b -> c -> d) -> (a -> b) -> (a -> c) -> a -> d</a></code></h3>
<h3 name="starling_"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L198">starling_ :: (b -> c -> d) -> (a -> b) -> (a -> c) -> a -> d</a></code></h3>

<h3 name="thrush"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L201">thrush :: a -> (a -> b) -> b</a></code></h3>
<h3 name="thrush"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L201">thrush :: a -> (a -> b) -> b</a></code></h3>

<h3 name="vireo"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L204">vireo :: a -> b -> (a -> b -> c) -> c</a></code></h3>
<h3 name="vireo"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L204">vireo :: a -> b -> (a -> b -> c) -> c</a></code></h3>

<h3 name="vireostar"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L207">vireostar :: (b -> a -> b -> d) -> a -> b -> b -> d</a></code></h3>
<h3 name="vireostar"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L207">vireostar :: (b -> a -> b -> d) -> a -> b -> b -> d</a></code></h3>

<h3 name="vireostarstar"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L210">vireostarstar :: (a -> c -> b -> c -> e) -> a -> b -> c -> c -> e</a></code></h3>
<h3 name="vireostarstar"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L210">vireostarstar :: (a -> c -> b -> c -> e) -> a -> b -> c -> c -> e</a></code></h3>

<h3 name="warbler"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L213">warbler :: (a -> a -> b) -> a -> b</a></code></h3>
<h3 name="warbler"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L213">warbler :: (a -> a -> b) -> a -> b</a></code></h3>

<h3 name="warbler1"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L216">warbler1 :: a -> (a -> a -> b) -> b</a></code></h3>
<h3 name="warbler1"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L216">warbler1 :: a -> (a -> a -> b) -> b</a></code></h3>

<h3 name="warblerstar"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L219">warblerstar :: (a -> b -> b -> c) -> a -> b -> c</a></code></h3>
<h3 name="warblerstar"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L219">warblerstar :: (a -> b -> b -> c) -> a -> b -> c</a></code></h3>

<h3 name="warblerstarstar"><code><a href="https://github.com/stoeffel/fantasy-birds/blob/master/fantasy-birds.js#L222">warblerstarstar :: (a -> b -> c -> c -> d) -> a -> b -> c -> d</a></code></h3>
<h3 name="warblerstarstar"><code><a href="https://github.com/fantasyland/fantasy-birds/blob/master/fantasy-birds.js#L222">warblerstarstar :: (a -> b -> c -> c -> d) -> a -> b -> c -> d</a></code></h3>

0 comments on commit 6400bd5

Please sign in to comment.