Skip to content
This repository has been archived by the owner on Jan 15, 2022. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
Create gh-pages branch via GitHub
  • Loading branch information
rktoomey committed Aug 20, 2013
1 parent 2684dac commit 1c6bc41
Show file tree
Hide file tree
Showing 11 changed files with 657 additions and 44 deletions.
Binary file added images/body-bg.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/highlight-bg.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/hr.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/octocat-icon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/tar-gz-icon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/zip-icon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
101 changes: 58 additions & 43 deletions index.html
@@ -1,34 +1,38 @@
<!doctype html>
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<title>Salat by novus</title>

<link rel="stylesheet" href="stylesheets/styles.css">
<link rel="stylesheet" href="stylesheets/pygment_trac.css">
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<link href='https://fonts.googleapis.com/css?family=Chivo:900' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen" />
<link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen" />
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<title>Salat by novus</title>
</head>

<body>
<div class="wrapper">
<header>
<h1>Salat</h1>
<p>A simple serialization library for case classes.</p>
<div id="container">
<div class="inner">

<header>
<h1>Salat</h1>
<h2>A simple serialization library for case classes.</h2>
</header>

<p class="view"><a href="https://github.com/novus/salat">View the Project on GitHub <small>novus/salat</small></a></p>
<section id="downloads" class="clearfix">
<a href="https://github.com/novus/salat/zipball/master" id="download-zip" class="button"><span>Download .zip</span></a>
<a href="https://github.com/novus/salat/tarball/master" id="download-tar-gz" class="button"><span>Download .tar.gz</span></a>
<a href="https://github.com/novus/salat" id="view-on-github" class="button"><span>View on GitHub</span></a>
</section>

<hr>

<ul>
<li><a href="https://github.com/novus/salat/zipball/master">Download <strong>ZIP File</strong></a></li>
<li><a href="https://github.com/novus/salat/tarball/master">Download <strong>TAR Ball</strong></a></li>
<li><a href="https://github.com/novus/salat">View On <strong>GitHub</strong></a></li>
</ul>
</header>
<section>
<h1>Salat</h1>
<section id="main_content">
<h1>
<a name="salat" class="anchor" href="#salat"><span class="octicon octicon-link"></span></a>Salat</h1>

<p>Salat is a simple serialization library for case classes.</p>

Expand All @@ -38,39 +42,43 @@ <h1>Salat</h1>
<li>MongoDB's <code>DBObject</code> (using <a href="https://github.com/mongodb/casbah/">casbah</a>)</li>
<li>JSON (using <a href="http://json4s.org/">JSON4S</a>)</li>
<li>maps</li>
</ul><h1>Goals</h1>
</ul><h1>
<a name="goals" class="anchor" href="#goals"><span class="octicon octicon-link"></span></a>Goals</h1>

<p>Simplicity. Flexibility. Consistency.</p>

<p>Your model there and back again should just work.</p>

<h1>Get Salat</h1>
<h1>
<a name="get-salat" class="anchor" href="#get-salat"><span class="octicon octicon-link"></span></a>Get Salat</h1>

<p>Salat publishes snapshots and releases to OSS Sontatype.</p>

<p>Please remove all references to <code>repo.novus.com</code> from your build files. After 0.0.8, Salat will be hosted exclusively by Sonatype.</p>

<h2>Stable Release</h2>
<h2>
<a name="stable-release" class="anchor" href="#stable-release"><span class="octicon octicon-link"></span></a>Stable Release</h2>

<p>Available for Scala 2.9.1 and 2.9.2. Based on Casbah 2.4.1.</p>
<p>Available for Scala 2.10, 2.9.2, and 2.9.1. Based on Casbah 2.6.2.</p>

<pre><code>"com.novus" %% "salat" % "1.9.1"
<pre><code>"com.novus" %% "salat" % "1.9.2"
</code></pre>

<p><a href="http://notes.implicit.ly/post/30497070468/salat-1-9-1">Release Notes</a></p>
<p><a href="http://notes.implicit.ly/post/58752640996/salat-1-9-2">Release Notes</a></p>

<p>Available for Scala 2.8.1, 2.9.1 and 2.9.2. Based on Casbah 2.1.5-1.</p>
<p>Legacy support for Scala 2.8.1. Based on Casbah 2.1.5-1.</p>

<pre><code>"com.novus" %% "salat" % "0.0.8"
</code></pre>

<p><a href="http://notes.implicit.ly/post/25793638048/salat-0-0-8">Release Notes</a></p>

<h2>Snapshot</h2>
<h2>
<a name="snapshot" class="anchor" href="#snapshot"><span class="octicon octicon-link"></span></a>Snapshot</h2>

<p><a href="http://travis-ci.org/novus/salat"><img src="https://secure.travis-ci.org/novus/salat.png" alt="Build Status"></a> Available for Scala 2.9.1 and 2.9.2.</p>
<p><a href="http://travis-ci.org/novus/salat"><img src="https://secure.travis-ci.org/novus/salat.png" alt="Build Status"></a> Available for Scala 2.10 and 2.9.2. Based on Casbah 2.6.2.</p>

<pre><code>"com.novus" %% "salat" % "1.9.2-SNAPSHOT"
<pre><code>"com.novus" %% "salat" % "1.9.3-SNAPSHOT"
</code></pre>

<p>If you are not using sbt 0.11.2+, explicitly add OSS Sonatype to your resolvers:</p>
Expand All @@ -80,19 +88,23 @@ <h2>Snapshot</h2>

<p><a href="https://github.com/novus/salat/blob/master/notes/1.9.1.markdown">Release Notes (In Progress)</a></p>

<h2>Play 2 plugin</h2>
<h2>
<a name="play-2-plugin" class="anchor" href="#play-2-plugin"><span class="octicon octicon-link"></span></a>Play 2 plugin</h2>

<p>Are you using Play framework? Make sure to see our <a href="https://github.com/novus/salat/wiki/SalatWithPlay2">Play support</a> wiki page, and check out Leon Radley's plugin at <a href="https://github.com/leon/play-salat">leon/play-salat</a>.</p>

<h1>Documentation</h1>
<h1>
<a name="documentation" class="anchor" href="#documentation"><span class="octicon octicon-link"></span></a>Documentation</h1>

<p>See the <a href="https://github.com/novus/salat/wiki">wiki</a> and the <a href="http://groups.google.com/group/scala-salat">mailing list</a>.</p>

<h1>What does Salat support?</h1>
<h1>
<a name="what-does-salat-support" class="anchor" href="#what-does-salat-support"><span class="octicon octicon-link"></span></a>What does Salat support?</h1>

<p>See <a href="https://github.com/novus/salat/wiki/SupportedTypes">Supported Types</a>.</p>

<h1>What doesn't Salat support?</h1>
<h1>
<a name="what-doesnt-salat-support" class="anchor" href="#what-doesnt-salat-support"><span class="octicon octicon-link"></span></a>What doesn't Salat support?</h1>

<p>We don't have the resources to support everything. Here are some things Salat doesn't do:</p>

Expand All @@ -108,7 +120,8 @@ <h1>What doesn't Salat support?</h1>
<li>
<code>Option</code> containing a collection (see <a href="https://github.com/novus/salat/wiki/Collections">collection support</a> for workarounds)</li>
<li>relationship management like a traditional ORM</li>
</ul><h1>How does Salat work?</h1>
</ul><h1>
<a name="how-does-salat-work" class="anchor" href="#how-does-salat-work"><span class="octicon octicon-link"></span></a>How does Salat work?</h1>

<p>Salat uses the <code>Product</code> trait implemented by case classes with the hi-fi type information found in pickled Scala signatures.</p>

Expand All @@ -120,14 +133,14 @@ <h1>What doesn't Salat support?</h1>
<li>SID # 10 (draft) - <a href="http://www.scala-lang.org/sid/10">Storage of pickled Scala signatures in class files</a>
</li>
</ul>
</section>
<footer>
<p>This project is maintained by <a href="https://github.com/novus">novus</a></p>
<p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
</footer>
</div>
<script src="javascripts/scale.fix.js"></script>
<script type="text/javascript">
</section>

<footer>
Salat is maintained by <a href="https://github.com/novus">novus</a><br>
This page was generated by <a href="http://pages.github.com">GitHub Pages</a>. Tactile theme by <a href="https://twitter.com/jasonlong">Jason Long</a>.
</footer>

<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
Expand All @@ -138,5 +151,7 @@ <h1>What doesn't Salat support?</h1>
} catch(err) {}
</script>

</div>
</div>
</body>
</html>
1 change: 1 addition & 0 deletions javascripts/main.js
@@ -0,0 +1 @@
console.log('This would be the main JS file.');
2 changes: 1 addition & 1 deletion params.json
@@ -1 +1 @@
{"google":"UA-32903332-1","note":"Don't delete this file! It's used internally to help with page regeneration.","tagline":"A simple serialization library for case classes.","name":"Salat","body":"# Salat\r\n\r\nSalat is a simple serialization library for case classes.\r\n\r\nSalat currently supports bidirectional serialization for:\r\n\r\n- MongoDB's `DBObject` (using [casbah][casbah])\r\n- JSON (using [JSON4S][JSON4S])\r\n- maps\r\n\r\n# Goals\r\n\r\nSimplicity. Flexibility. Consistency.\r\n\r\nYour model there and back again should just work.\r\n\r\n# Get Salat\r\n\r\nSalat publishes snapshots and releases to OSS Sontatype.\r\n\r\nPlease remove all references to `repo.novus.com` from your build files. After 0.0.8, Salat will be hosted exclusively by Sonatype.\r\n\r\n## Stable Release\r\n\r\nAvailable for Scala 2.9.1 and 2.9.2. Based on Casbah 2.4.1.\r\n\r\n \"com.novus\" %% \"salat\" % \"1.9.1\"\r\n\r\n[Release Notes](http://notes.implicit.ly/post/30497070468/salat-1-9-1)\r\n\r\nAvailable for Scala 2.8.1, 2.9.1 and 2.9.2. Based on Casbah 2.1.5-1.\r\n\r\n \"com.novus\" %% \"salat\" % \"0.0.8\"\r\n\r\n[Release Notes](http://notes.implicit.ly/post/25793638048/salat-0-0-8)\r\n\r\n## Snapshot\r\n\r\n[![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.\r\n\r\n \"com.novus\" %% \"salat\" % \"1.9.2-SNAPSHOT\"\r\n\r\nIf you are not using sbt 0.11.2+, explicitly add OSS Sonatype to your resolvers:\r\n\r\n resolvers += \"Sonatype OSS Snapshots\" at \"https://oss.sonatype.org/content/repositories/snapshots\"\r\n\r\n[Release Notes (In Progress)](https://github.com/novus/salat/blob/master/notes/1.9.1.markdown)\r\n\r\n## Play 2 plugin\r\n\r\nAre 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].\r\n\r\n# Documentation\r\n\r\nSee the [wiki][wiki] and the [mailing list][group].\r\n\r\n# What does Salat support?\r\n\r\nSee [Supported Types][types].\r\n\r\n# What doesn't Salat support?\r\n\r\nWe don't have the resources to support everything. Here are some things Salat doesn't do:\r\n\r\n- Java compatibility\r\n- non-case classes\r\n- type aliases\r\n- nested inner classes\r\n- varags\r\n- arrays\r\n- multiple constructors\r\n- tuples\r\n- `Option` containing a collection (see [collection support][collections] for workarounds)\r\n- relationship management like a traditional ORM\r\n\r\n# How does Salat work?\r\n\r\nSalat uses the `Product` trait implemented by case classes with the hi-fi type information found in pickled Scala signatures.\r\n\r\nDetails are thin on the ground, but here's where we got started:\r\n\r\n- the source code for `scala.tools.scalap.scalax.rules.scalasig.ScalaSigParser`\r\n- SID # 10 (draft) - [Storage of pickled Scala signatures in class files][sid10]\r\n\r\n[types]: https://github.com/novus/salat/wiki/SupportedTypes\r\n[wiki]: https://github.com/novus/salat/wiki\r\n[casbah]: https://github.com/mongodb/casbah/\r\n[JSON4S]: http://json4s.org/\r\n[group]: http://groups.google.com/group/scala-salat\r\n[play-salat]: https://github.com/novus/salat/wiki/SalatWithPlay2\r\n[play-salat-plugin]: https://github.com/leon/play-salat\r\n[sid10]: http://www.scala-lang.org/sid/10\r\n[typehint]: https://github.com/novus/salat/wiki/TypeHints\r\n[collections]: https://github.com/novus/salat/wiki/Collections"}
{"name":"Salat","tagline":"A simple serialization library for case classes.","body":"# Salat\r\n\r\nSalat is a simple serialization library for case classes.\r\n\r\nSalat currently supports bidirectional serialization for:\r\n\r\n- MongoDB's `DBObject` (using [casbah][casbah])\r\n- JSON (using [JSON4S][JSON4S])\r\n- maps\r\n\r\n# Goals\r\n\r\nSimplicity. Flexibility. Consistency.\r\n\r\nYour model there and back again should just work.\r\n\r\n# Get Salat\r\n\r\nSalat publishes snapshots and releases to OSS Sontatype.\r\n\r\nPlease remove all references to `repo.novus.com` from your build files. After 0.0.8, Salat will be hosted exclusively by Sonatype.\r\n\r\n## Stable Release\r\n\r\nAvailable for Scala 2.10, 2.9.2, and 2.9.1. Based on Casbah 2.6.2.\r\n\r\n \"com.novus\" %% \"salat\" % \"1.9.2\"\r\n\r\n[Release Notes](http://notes.implicit.ly/post/58752640996/salat-1-9-2)\r\n\r\nLegacy support for Scala 2.8.1. Based on Casbah 2.1.5-1.\r\n\r\n \"com.novus\" %% \"salat\" % \"0.0.8\"\r\n\r\n[Release Notes](http://notes.implicit.ly/post/25793638048/salat-0-0-8)\r\n\r\n## Snapshot\r\n\r\n[![Build Status](https://secure.travis-ci.org/novus/salat.png)](http://travis-ci.org/novus/salat) Available for Scala 2.10 and 2.9.2. Based on Casbah 2.6.2.\r\n\r\n \"com.novus\" %% \"salat\" % \"1.9.3-SNAPSHOT\"\r\n\r\nIf you are not using sbt 0.11.2+, explicitly add OSS Sonatype to your resolvers:\r\n\r\n resolvers += \"Sonatype OSS Snapshots\" at \"https://oss.sonatype.org/content/repositories/snapshots\"\r\n\r\n[Release Notes (In Progress)](https://github.com/novus/salat/blob/master/notes/1.9.1.markdown)\r\n\r\n## Play 2 plugin\r\n\r\nAre 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].\r\n\r\n# Documentation\r\n\r\nSee the [wiki][wiki] and the [mailing list][group].\r\n\r\n# What does Salat support?\r\n\r\nSee [Supported Types][types].\r\n\r\n# What doesn't Salat support?\r\n\r\nWe don't have the resources to support everything. Here are some things Salat doesn't do:\r\n\r\n- Java compatibility\r\n- non-case classes\r\n- type aliases\r\n- nested inner classes\r\n- varags\r\n- arrays\r\n- multiple constructors\r\n- tuples\r\n- `Option` containing a collection (see [collection support][collections] for workarounds)\r\n- relationship management like a traditional ORM\r\n\r\n# How does Salat work?\r\n\r\nSalat uses the `Product` trait implemented by case classes with the hi-fi type information found in pickled Scala signatures.\r\n\r\nDetails are thin on the ground, but here's where we got started:\r\n\r\n- the source code for `scala.tools.scalap.scalax.rules.scalasig.ScalaSigParser`\r\n- SID # 10 (draft) - [Storage of pickled Scala signatures in class files][sid10]\r\n\r\n[types]: https://github.com/novus/salat/wiki/SupportedTypes\r\n[wiki]: https://github.com/novus/salat/wiki\r\n[casbah]: https://github.com/mongodb/casbah/\r\n[JSON4S]: http://json4s.org/\r\n[group]: http://groups.google.com/group/scala-salat\r\n[play-salat]: https://github.com/novus/salat/wiki/SalatWithPlay2\r\n[play-salat-plugin]: https://github.com/leon/play-salat\r\n[sid10]: http://www.scala-lang.org/sid/10\r\n[typehint]: https://github.com/novus/salat/wiki/TypeHints\r\n[collections]: https://github.com/novus/salat/wiki/Collections","google":"UA-32903332-1","note":"Don't delete this file! It's used internally to help with page regeneration."}

0 comments on commit 1c6bc41

Please sign in to comment.