Skip to content

Commit 16d7d11

Browse files
committed
Add license and publish version 0.1.0
1 parent beb4660 commit 16d7d11

File tree

7 files changed

+35
-3
lines changed

7 files changed

+35
-3
lines changed

LICENSE

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
The MIT License (MIT)
2+
Copyright (c) 2016 Nick Stanchenko
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5+
6+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
7+
8+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,14 @@ the [tutorial](TUTORIAL.md).
108108

109109
### Usage
110110

111+
Include these lines in your `build.sbt`:
112+
113+
```scala
114+
resolvers += Resolver.bintrayRepo("stanch", "maven")
115+
116+
libraryDependencies += "org.stanch" %% "zipper" % "0.1.0"
117+
```
118+
111119
#### Unzip
112120

113121
In order for the Zipper to work on your data structure `Tree`, you need an implicit instance of `Unzip[Tree]`.
@@ -129,7 +137,7 @@ scala> case class Tree(x: Int, c: Vector[Tree] = Vector.empty)
129137
defined class Tree
130138

131139
scala> implicit val unzip = Unzip.For[Tree, Vector].derive
132-
unzip: zipper.Unzip[Tree] = zipper.GenericUnzipInstances$For$$anon$2@249f9a91
140+
unzip: zipper.Unzip[Tree] = zipper.GenericUnzipInstances$For$$anon$2@200d382
133141
```
134142

135143
The automatic derivation is powered by [shapeless](https://github.com/milessabin/shapeless).

TUTORIAL.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ assert(tree2b == tree2)
8181

8282
The power of Zipper becomes apparent when we go one or more levels deep.
8383
To move down the tree, we “unzip” it, separating the child nodes into
84-
the focused node and left and right siblings:
84+
the focused node and its left and right siblings:
8585

8686
```scala
8787
val zipper2 = zipper1.moveDownLeft

build.sbt

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1+
organization := "org.stanch"
2+
13
name := "zipper"
24

5+
version := "0.1.0"
6+
7+
licenses += ("MIT", url("http://opensource.org/licenses/MIT"))
8+
39
scalaVersion := "2.11.7"
410

511
resolvers += Resolver.bintrayRepo("stanch", "maven")

project/plugins.sbt

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.3.5")
22

33
addSbtPlugin("org.tpolecat" % "tut-plugin" % "0.4.2")
4+
5+
addSbtPlugin("me.lessis" % "bintray-sbt" % "0.3.0")

src/main/tut/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,14 @@ the [tutorial](TUTORIAL.md).
108108

109109
### Usage
110110

111+
Include these lines in your `build.sbt`:
112+
113+
```scala
114+
resolvers += Resolver.bintrayRepo("stanch", "maven")
115+
116+
libraryDependencies += "org.stanch" %% "zipper" % "0.1.0"
117+
```
118+
111119
#### Unzip
112120

113121
In order for the Zipper to work on your data structure `Tree`, you need an implicit instance of `Unzip[Tree]`.

src/main/tut/TUTORIAL.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ assert(tree2b == tree2)
8989

9090
The power of Zipper becomes apparent when we go one or more levels deep.
9191
To move down the tree, we “unzip” it, separating the child nodes into
92-
the focused node and left and right siblings:
92+
the focused node and its left and right siblings:
9393

9494
```tut:silent
9595
val zipper2 = zipper1.moveDownLeft

0 commit comments

Comments
 (0)