Browse files

add readme

  • Loading branch information...
1 parent 63f4e57 commit 3bfcdf55422156bc011c75e4507781213300fb90 @alexott committed Mar 25, 2010
Showing with 16 additions and 5 deletions.
  1. +16 −5 README
@@ -1,15 +1,26 @@
-# tika
+# clj-tika
-Interface to Apache Tika project
+Clojure interface to Apache Tika project functions
## Usage
-FIXME: write
+This package provides several functions in the `tika` package:
+ * `parse` - parses given file or stream and returns map with meta-information & text
+ extracted from file. Text is stored under key `:text`
+ * `detect-mime-type` - performs detection of mime type of given file or stream. Returns
+ text string with mime-type
+ * `detect-language` - performs language detection for given text. Returns text string
+ with [ISO 639 language code](
## Installation
-FIXME: write
+Execute `lein install` to install it into local Maven repository
## License
-FIXME: write
+Copyright (c) Alex Ott, Inc. All rights reserved.
+The use and distribution terms for this software are covered by the Eclipse Public License
+1.0 ( which can be found in the file
+epl-v10.html at the root of this distribution. By using this software in any fashion, you
+are agreeing to be bound by the terms of this license.

0 comments on commit 3bfcdf5

Please sign in to comment.