Permalink
Browse files

Update README.

  • Loading branch information...
1 parent 54ea78a commit 0a16061fa24aa28614cdf5efc9f36dc43a852073 Alexander Taggart committed Oct 24, 2011
Showing with 34 additions and 4 deletions.
  1. +34 −4 README.md
View
38 README.md
@@ -1,11 +1,41 @@
-# Codec
+# data.codec
-Native codec implementations.
+Native codec implementations. Currently only base64 has been implemented.
-## Base64
+## base64
-Supports the standard base64 encoding character set.
+Implements the standard base64 encoding character set, but does not yet support automatic fixed line-length encoding.
+All operations work on either byte arrays or Input/OutputStreams.
+
+Performance is on par with Java implementations, e.g., Apache commons-codec.
+
+### Example Usage
+
+Transform a binary file into a base64 encoded file:
+
+```clojure
+(require '[clojure.data.codec.base64 :as b64]
+ '[clojure.java.io :as io])
+
+(with-open [in (io/input-stream "input.bin")
+ out (io/output-stream "output.b64")]
+ (b64/encoding-transfer in out))
+```
+
+## Installation
+
+The data.codec library is available in Maven central. Add it to your Maven project's `pom.xml`:
+
+ <dependency>
+ <groupId>org.clojure</groupId>
+ <artifactId>data.codec</artifactId>
+ <version>0.1.0</version>
+ </dependency>
+
+or your leiningen `project.clj`:
+
+ [org.clojure/data.codec "0.1.0"]
## License

0 comments on commit 0a16061

Please sign in to comment.