Skip to content

Commit

Permalink
api doc link
Browse files Browse the repository at this point in the history
  • Loading branch information
erikerlandson committed Mar 5, 2017
1 parent 141dd6c commit dc3126e
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,17 @@ A lightweight library for 'break' and 'continue' in Scala for-comprehensions
### Use `breakable` in your project
[![Download](https://api.bintray.com/packages/manyangled/maven/breakable/images/download.svg?version=0.1.0) ](https://bintray.com/manyangled/maven/breakable/0.1.0/link)

##### SBT
```scala
resolvers += "manyangled" at "https://dl.bintray.com/manyangled/maven/"

libraryDependencies += "com.manyangled" %% "breakable" % "0.1.0"
```

### Examples
##### API Doc
https://erikerlandson.github.io/breakable/latest/api/#package

### Examples
The `breakable` library implements the `break` and `continue` operators on Scala sequences in `for` comprehensions. The result of a `for` comprehension over "breakable sequences" can be returned as a variety of standard Scala sequences:
```scala
scala> import com.manyangled.breakable._
Expand Down

0 comments on commit dc3126e

Please sign in to comment.