Skip to content

Commit

Permalink
Finalizing docs and moving to io.suzaku
Browse files Browse the repository at this point in the history
  • Loading branch information
ochrons committed Jan 25, 2017
1 parent 5543033 commit a33583f
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
language: scala
scala:
- 2.11.7
- 2.11.8
sudo: false
jdk:
- oraclejdk7
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ and [Prickle](https://github.com/benhutchison/prickle) so special thanks to Li H
- Serialization support for all primitives, collections, options, tuples and case classes (including class hierarchies)
- User-definable custom serializers
- Transforming serializers to simplify serializing non-case classes
- Handles [references and deduplication of identical objects](#references)
- Handles references and deduplication of identical objects
- Very fast
- Very efficient coding
- Low memory usage, no intermediate structures needed
Expand All @@ -29,13 +29,13 @@ and [Prickle](https://github.com/benhutchison/prickle) so special thanks to Li H
Add following dependency declaration to your Scala project

```scala
"me.chrons" %% "boopickle" % "1.2.5"
"io.suzaku" %% "boopickle" % "1.2.6"
```

On a Scala.js project the dependency looks like this

```scala
"me.chrons" %%% "boopickle" % "1.2.5"
"io.suzaku" %%% "boopickle" % "1.2.6"
```

To use it in your code, simply import the Default object contents. All examples in this document assume this import is present.
Expand All @@ -61,7 +61,7 @@ val helloWorld = Unpickle[Seq[String]].fromBytes(buf)

## Documentation

Read the [full documentation](https://ochrons.github.io/boopickle)
Read the [full documentation](https://boopickle.suzaku.io)

## Change history

Expand Down
12 changes: 6 additions & 6 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ lazy val boopickle = crossProject
.settings(
name := "boopickle",
scmInfo := Some(
ScmInfo(url("https://github.com/ochrons/boopickle"),
"scm:git:git@github.com:ochrons/boopickle.git",
Some("scm:git:git@github.com:ochrons/boopickle.git"))),
ScmInfo(url("https://github.com/suzaku-io/boopickle"),
"scm:git:git@github.com:suzaku-io/boopickle.git",
Some("scm:git:git@github.com:suzaku-io/boopickle.git"))),
publishMavenStyle := true,
publishArtifact in Test := false,
pomExtra :=
<url>https://github.com/ochrons/boopickle</url>
<url>https://github.com/suzaku-io/boopickle</url>
<licenses>
<license>
<name>MIT license</name>
Expand Down Expand Up @@ -82,7 +82,7 @@ lazy val boopickle = crossProject
else
Seq({
val a = baseDirectory.value.toURI.toString.replaceFirst("[^/]+/?$", "")
val g = "https://raw.githubusercontent.com/ochrons/boopickle"
val g = "https://raw.githubusercontent.com/suzaku-io/boopickle"
s"-P:scalajs:mapSourceURI:$a->$g/v${version.value}/"
}))
)
Expand Down Expand Up @@ -158,5 +158,5 @@ lazy val perftestsJVM = preventPublication(perftests.jvm)
.dependsOn(boopickleJVM)

lazy val root = preventPublication(project.in(file(".")))
.settings()
.settings(commonSettings: _*)
.aggregate(boopickleJS, boopickleJVM)
2 changes: 1 addition & 1 deletion doc/Details.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ trait MaterializePicklerFallback {

If no other implicit pickler can be found, the compiler will call the `materializePickler` macro function in the hope of generating a suitable one.

The [macro code](https://github.com/ochrons/boopickle/blob/master/boopickle/shared/src/main/scala/boopickle/PicklerMaterializersImpl.scala) starts
The [macro code](https://github.com/suzaku-io/boopickle/blob/master/boopickle/shared/src/main/scala/boopickle/PicklerMaterializersImpl.scala) starts
by checking that the given type is valid for pickling (a sealed trait or a case class). Next step is building the code for pickling individual fields
of the case class, which is surprisingly simple. Scala macros use a concept called quasiquotes (`q"""code goes here"""`) to easily generate code.

Expand Down
2 changes: 1 addition & 1 deletion doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ and [Prickle](https://github.com/benhutchison/prickle) so special thanks to Li H
- Serialization support for all primitives, collections, options, tuples and case classes (including class hierarchies)
- User-definable custom serializers
- Transforming serializers to simplify serializing non-case classes
- Handles [references and deduplication of identical objects](#references)
- Handles references and deduplication of identical objects
- Very fast
- Very efficient coding
- Low memory usage, no intermediate structures needed
Expand Down
2 changes: 1 addition & 1 deletion project/Version.scala
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
object Version {
val library = "1.2.6-SNAPSHOT"
val library = "1.2.6"
}
1 change: 1 addition & 0 deletions publishDocs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ touch .nojekyll
git add .
git commit -am "update book"
git push git@github.com:ochrons/boopickle gh-pages --force
cd ..

0 comments on commit a33583f

Please sign in to comment.