Skip to content

Commit

Permalink
Update readme with ScalaJS sections
Browse files Browse the repository at this point in the history
  • Loading branch information
lloydmeta committed Dec 12, 2015
1 parent c813bad commit 434971d
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,15 @@ libraryDependencies ++= Seq(
)
```

For enumeratum with [uPickle](http://lihaoyi.github.io/upickle/):

```scala
libraryDependencies ++= Seq(
"com.beachape" %% "enumeratum" % "1.3.3",
"com.beachape" %% "enumeratum-upickle" % "1.3.3"
)
```

For enumeratum with Play JSON:
```scala
libraryDependencies ++= Seq(
Expand All @@ -50,6 +59,25 @@ libraryDependencies ++= Seq(
)
```

### ScalaJs

There is support for ScalaJs, though only for the core lib and the UPickle helper lib.

```scala
libraryDependencies ++= Seq(
"com.beachape" %%% "enumeratum" % "1.3.3"
)
```

To use with uPickle:

```scala
libraryDependencies ++= Seq(
"com.beachape" %%% "enumeratum" % "1.3.3",
"com.beachape" %%% "enumeratum-upickle" % "1.3.3"
)
```

## How-to + example

Using Enumeratum is simple. Simply declare your own sealed trait or class `A`, and implement it as case objects inside
Expand Down

0 comments on commit 434971d

Please sign in to comment.