Skip to content
Newer
Older
100644 94 lines (58 sloc) 2.96 KB
59db2bd @maxaf brief description of what I'm trying to achieve here
maxaf authored
1 # Salat
2
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
3 Salat is a simple serialization library for case classes.
59db2bd @maxaf brief description of what I'm trying to achieve here
maxaf authored
4
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
5 Salat currently supports bidirectional serialization for:
a09cb27 @rktoomey Redux of readme
rktoomey authored
6
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
7 - MongoDB's `DBObject` (using [casbah][casbah])
8 - JSON (using [lift-json][lift-json])
9 - maps
a09cb27 @rktoomey Redux of readme
rktoomey authored
10
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
11 # Goals
6279fd3 @rktoomey Readme now contains details on latest builds of salat
rktoomey authored
12
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
13 Simplicity. Flexibility. Consistency.
6279fd3 @rktoomey Readme now contains details on latest builds of salat
rktoomey authored
14
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
15 Your model there and back again should just work.
6279fd3 @rktoomey Readme now contains details on latest builds of salat
rktoomey authored
16
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
17 # Get Salat
6279fd3 @rktoomey Readme now contains details on latest builds of salat
rktoomey authored
18
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
19 Salat publishes snapshots and releases to OSS Sontatype.
59db2bd @maxaf brief description of what I'm trying to achieve here
maxaf authored
20
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
21 Please remove all references to `repo.novus.com` from your build files. After 0.0.8, Salat will be hosted exclusively by Sonatype.
59db2bd @maxaf brief description of what I'm trying to achieve here
maxaf authored
22
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
23 ## Stable Release
59db2bd @maxaf brief description of what I'm trying to achieve here
maxaf authored
24
972494e @rktoomey Bumped version number to 1.9.0 for release linked to Casbah 2.4.1.
rktoomey authored
25 Available for Scala 2.9.1 and 2.9.2. Based on Casbah 2.4.1.
26
7fec5e2 @rktoomey Hello 1.9.2-SNAPSHOT
rktoomey authored
27 "com.novus" %% "salat" % "1.9.1"
972494e @rktoomey Bumped version number to 1.9.0 for release linked to Casbah 2.4.1.
rktoomey authored
28
7fec5e2 @rktoomey Hello 1.9.2-SNAPSHOT
rktoomey authored
29 [Release Notes](http://notes.implicit.ly/post/30497070468/salat-1-9-1)
ac94a90 @rktoomey Ticked build version over to 1.9.1-SNAPSHOT
rktoomey authored
30
972494e @rktoomey Bumped version number to 1.9.0 for release linked to Casbah 2.4.1.
rktoomey authored
31 Available for Scala 2.8.1, 2.9.1 and 2.9.2. Based on Casbah 2.1.5-1.
4470225 @rktoomey Specify available Scala versions for releases.
rktoomey authored
32
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
33 "com.novus" %% "salat" % "0.0.8"
59db2bd @maxaf brief description of what I'm trying to achieve here
maxaf authored
34
824dc50 @rktoomey 1.9-SNAPSHOT now links to release notes.
rktoomey authored
35 [Release Notes](http://notes.implicit.ly/post/25793638048/salat-0-0-8)
36
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
37 ## Snapshot
59db2bd @maxaf brief description of what I'm trying to achieve here
maxaf authored
38
576b010 @rktoomey Tweak build status image placement.
rktoomey authored
39 [![Build Status](https://secure.travis-ci.org/novus/salat.png)](http://travis-ci.org/novus/salat) Available for Scala 2.9.1 and 2.9.2.
4470225 @rktoomey Specify available Scala versions for releases.
rktoomey authored
40
7fec5e2 @rktoomey Hello 1.9.2-SNAPSHOT
rktoomey authored
41 "com.novus" %% "salat" % "1.9.2-SNAPSHOT"
59db2bd @maxaf brief description of what I'm trying to achieve here
maxaf authored
42
664d07f @rktoomey README now specifies OSS Sonatype snaps for salat snapshots.
rktoomey authored
43 If you are not using sbt 0.11.2+, explicitly add OSS Sonatype to your resolvers:
44
45 resolvers += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"
46
ac94a90 @rktoomey Ticked build version over to 1.9.1-SNAPSHOT
rktoomey authored
47 [Release Notes (In Progress)](https://github.com/novus/salat/blob/master/notes/1.9.1.markdown)
7c3c073 @rktoomey Update Casbah deps to 2.3.0
rktoomey authored
48
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
49 ## Play 2 plugin
59db2bd @maxaf brief description of what I'm trying to achieve here
maxaf authored
50
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
51 Are you using Play framework? Make sure to see our [Play support][play-salat] wiki page, and check out Leon Radley's plugin at [leon/play-salat][play-salat-plugin].
59db2bd @maxaf brief description of what I'm trying to achieve here
maxaf authored
52
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
53 # Documentation
59db2bd @maxaf brief description of what I'm trying to achieve here
maxaf authored
54
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
55 See the [wiki][wiki] and the [mailing list][group].
59db2bd @maxaf brief description of what I'm trying to achieve here
maxaf authored
56
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
57 # What does Salat support?
59db2bd @maxaf brief description of what I'm trying to achieve here
maxaf authored
58
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
59 See [Supported Types][types].
59db2bd @maxaf brief description of what I'm trying to achieve here
maxaf authored
60
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
61 # What doesn't Salat support?
a09cb27 @rktoomey Redux of readme
rktoomey authored
62
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
63 We don't have the resources to support everything. Here are some things Salat doesn't do:
a09cb27 @rktoomey Redux of readme
rktoomey authored
64
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
65 - Java compatibility
66 - non-case classes
67 - type aliases
68 - nested inner classes
8860344 @rktoomey Clarified and expanded list of what Salat doesn't support
rktoomey authored
69 - varags
70 - arrays
d5f843c @rktoomey Bitte no multiple constructors, meine Damen und Herren.
rktoomey authored
71 - multiple constructors
972494e @rktoomey Bumped version number to 1.9.0 for release linked to Casbah 2.4.1.
rktoomey authored
72 - tuples
8860344 @rktoomey Clarified and expanded list of what Salat doesn't support
rktoomey authored
73 - `Option` containing a collection (see [collection support][collections] for workarounds)
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
74 - relationship management like a traditional ORM
a09cb27 @rktoomey Redux of readme
rktoomey authored
75
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
76 # How does Salat work?
d198425 @rktoomey Redux of readme
rktoomey authored
77
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
78 Salat uses the `Product` trait implemented by case classes with the hi-fi type information found in pickled Scala signatures.
d198425 @rktoomey Redux of readme
rktoomey authored
79
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
80 Details are thin on the ground, but here's where we got started:
d198425 @rktoomey Redux of readme
rktoomey authored
81
82 - the source code for `scala.tools.scalap.scalax.rules.scalasig.ScalaSigParser`
5b0aac8 @rktoomey Redux of readme
rktoomey authored
83 - SID # 10 (draft) - [Storage of pickled Scala signatures in class files][sid10]
d198425 @rktoomey Redux of readme
rktoomey authored
84
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
85 [types]: https://github.com/novus/salat/wiki/SupportedTypes
70a0013 @maxaf updated references
maxaf authored
86 [wiki]: https://github.com/novus/salat/wiki
90d7946 @rktoomey Updated notes for 0.0.8 release.
rktoomey authored
87 [casbah]: https://github.com/mongodb/casbah/
88 [lift-json]: https://github.com/lift/lift/tree/master/framework/lift-base/lift-json/
89 [group]: http://groups.google.com/group/scala-salat
be94d1b @rktoomey Fix link
rktoomey authored
90 [play-salat]: https://github.com/novus/salat/wiki/SalatWithPlay2
5c19abf @rktoomey Fixed SID 10 link
rktoomey authored
91 [play-salat-plugin]: https://github.com/leon/play-salat
1818c7a @rktoomey Context now defaults to type hinting only when necessary. The global …
rktoomey authored
92 [sid10]: http://www.scala-lang.org/sid/10
8860344 @rktoomey Clarified and expanded list of what Salat doesn't support
rktoomey authored
93 [typehint]: https://github.com/novus/salat/wiki/TypeHints
94 [collections]: https://github.com/novus/salat/wiki/Collections
Something went wrong with that request. Please try again.