Permalink
Browse files

Add README & License (apache-2.0)

  • Loading branch information...
Holden Karau
Holden Karau committed Aug 12, 2011
1 parent 7a4e97f commit 2f555f23a6f4217ce314e4ad13f9d46e38f35500
Showing with 48 additions and 0 deletions.
  1. +14 −0 LICENSE.txt
  2. +34 −0 README.md
View
@@ -0,0 +1,14 @@
+Copyright (c) 2011, Foursquare Labs, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
View
@@ -0,0 +1,34 @@
+# Slashem (SolrRogue)
+
+Slashem (SolrRogue) is a type-safe internal Scala DSL for constructing and
+executing find requests against SOLR. It is a rogue-like for solr. It is not
+currently full expressive to SOLR's query functionality, but covers the main
+use cases that we encountered.
+
+## Vuilding and Installation
+
+Use sbt (simple-build-tool) to build:
+
+ $ sbt clean update package
+
+The finished jar will be in 'target/'.
+
+## Examples
+[QueryTest.scala] contains sample queries and shows the corresponding solr query.
+[SolrRogueTest.scala] countains some sample records.
+
+## Dependencies
+
+lift, joda-time, junit, finagle. These dependencies are managed by the build system.
+
+## Maintainers
+
+Slashem (SolrRogue) was initial developed by Foursquare Labs for internal use.
+The majourity of our solr related calls at Foursquare go through this library.
+The current maintainers are:
+
+- Jon Shea jonshea@foursquare.com
+- Govind Kabra govind@foursquare.com
+- Holden Karau holden@foursquare.com
+
+Contributions welcome!

0 comments on commit 2f555f2

Please sign in to comment.