Permalink
Browse files

README and version bump to 0.0.1

  • Loading branch information...
1 parent 279c42f commit 9446e510acab30d4935e18a359395cf8119f7e7d @samstokes samstokes committed Sep 29, 2011
Showing with 41 additions and 1 deletion.
  1. +40 −0 README.markdown
  2. +1 −1 pom.xml
View
@@ -0,0 +1,40 @@
+# storm-json: JSON Serialisation for Storm #
+
+storm-json provides JSON serialisation support for
+[Storm](https://github.com/nathanmarz/storm). It currently provides two
+classes:
+
+ * SimpleJSONScheme: an implementation of
+ [`backtype.storm.spout.Scheme`](http://nathanmarz.github.com/storm/doc/backtype/storm/spout/Scheme.html)
+ for writing spouts that consume from a source producing JSON.
+ * SimpleJSONSerializer: an implementation of
+ [`backtype.storm.serialization.ISerialization`](http://nathanmarz.github.com/storm/doc/backtype/storm/serialization/ISerialization.html)
+ so that spouts and bolts can emit and receive tuples containing JSON values.
+
+## Usage ##
+
+To produce a jar:
+
+ $ mvn package
+
+To install in your local Maven repository:
+
+ $ mvn install
+
+To use in your `pom.xml`:
+
+```xml
+<project>
+ <!-- ... -->
+ <dependencies>
+ <!-- ... -->
+ <dependency>
+ <groupId>com.rapportive</groupId>
+ <artifactId>storm-json</artifactId>
+ <version>0.0.1</version>
+ </dependency>
+ <!-- ... -->
+ </dependencies>
+ <!-- ... -->
+</project>
+```
View
@@ -2,7 +2,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.rapportive</groupId>
<artifactId>storm-json</artifactId>
- <version>0.0.1-SNAPSHOT</version>
+ <version>0.0.1</version>
<repositories>
<repository>
<id>clojars.org</id>

0 comments on commit 9446e51

Please sign in to comment.