Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Community Section to README.md #127

Merged
merged 2 commits into from
Sep 6, 2013
Merged

Add Community Section to README.md #127

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7565dc
add community section
Sep 5, 2013
2e97415
add archive link.
Sep 5, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Chill [![Build Status](https://secure.travis-ci.org/twitter/chill.png)](http://travis-ci.org/twitter/chill)

Extensions for the [Kryo serialization library](http://code.google.com/p/kryo/) including
serializers and a set of classes to ease configuration of Kryo in systems like Hadoop, Storm,
serializers and a set of classes to ease configuration of Kryo in systems like Hadoop, Storm,
Akka, etc.

Chill has a set of subprojects: chill-java, chill-hadoop, chill-storm and chill-scala. Other than
Expand Down Expand Up @@ -101,11 +101,8 @@ only scala serializers). Chill provides support for singletons, scala Objects a
* all 22 scala tuples

## Chill-bijection
[Bijections and Injections](https://github.com/twitter/bijection)
are useful when considering serialization. If you have an Injection from
`T` to `Array[Byte]` you have a serialization. Additionally, if you have a Bijection between `A`
and `B`, and a serialization for `B`, then you have a serialization for `A`. See
`BijectionEnrichedKryo` for easy interop between bijection and chill.

[Bijections and Injections](https://github.com/twitter/bijection) are useful when considering serialization. If you have an Injection from `T` to `Array[Byte]` you have a serialization. Additionally, if you have a Bijection between `A` and `B`, and a serialization for `B`, then you have a serialization for `A`. See `BijectionEnrichedKryo` for easy interop between bijection and chill.

### KryoInjection: easy serialization to byte Arrays

Expand All @@ -120,6 +117,14 @@ val tryDecode: scala.util.Try[Any] = KryoInjection.invert(bytes)

KryoInjection can be composed with Bijections and Injections from `com.twitter.bijection`.

## Community and Documentation

To learn more and find links to tutorials and information around the web, check out the [Chill Wiki](https://github.com/twitter/chill/wiki).

The latest ScalaDocs are hosted on Chill's [Github Project Page](http://twitter.github.io/chill).

Discussion occurs primarily on the [Chill mailing list](http://librelist.com/browser/chill/). To join the mailing list, email [chill@librelist.com](mailto:chill@librelist.com). The same address is used for posting once you've joined. Issues should be reported on the [GitHub issue tracker](https://github.com/twitter/chill/issues).

## Maven

Chill modules are available on Maven Central. The current groupid and version for all modules is, respectively, `"com.twitter"` and `0.3.1`.
Expand Down