Add readme and license

3 files changed, 63 insertions, 0 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..48a3c81
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,30 @@
+Copyright (c) 2018, Jakob Odersky
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+    Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+
+    Neither the name of the authors nor the names of its contributors
+    may be used to endorse or promote products derived from this
+    software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..55603e8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Identicons
+
+A tiny implementation of
+[identicons](https://en.wikipedia.org/wiki/Identicon), similar to the
+ones used by GitHub for new avatars.
+
+## Dependencies
+
+This library is totally self-contained, there are no 3rd party
+dependencies. It is built and published for Scala on JVM, JS and
+Native.
+
+```sbt
+"io.crashbox" %%% "identicon" % "<unreleased>"
+```
+
+## Usage
+
+```scala
+// generate identicon for user "admin" in SVG form
+identicon.svg("admin") // = <svg width="5" height="5"><rect x="0" y="3" ...
+
+// in base64 data url form
+identicon.url("admin") // = data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0...
+
+```
+
+See the [online generator](https://jakob.odersky.com/identicon) for an
+interactive preview. The generator is simply a static site that uses
+the ScalaJS version of this library.
diff --git a/mksite b/mksite
index 1377d6b..caedd4d 100755
--- a/mksite
+++ b/mksite
@@ -1,4 +1,7 @@
 #!/bin/bash
+# Build an identicon generator website, optionally publish it if
+# "publish" is given as first argument.
+
 set -o errexit
 
 ghpages=.ghpages