Added license and README

diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..ef59425
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+
+Copyright 2011 Kristopher Michael Kowal. All rights reserved.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..14ab82c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+
+This is a Tengwar transcriber suitable for transcribing Sindarin
+Elvish from a phonetic encoding of the Latin alphabet, to the General
+Use mode of the Tengwar.  It is written in JavaScript and is suitable
+for use as:
+
+-   A plain script in a web page.
+-   A jQuery plugin.
+-   A CommonJS module as used by Node, with the NPM package name
+    ``tengwar``.
+-   A RequireJS script as used by Dojo and others.
+
+The script depends on a shimmable subset of ECMAScript 5.  You might
+benefit from using ES5 Shim if you're deploying to older browsers.
+
+    <https://github.com/kriskowal/es5-shim>
+
+The API includes:
+
+-   ``transcribe(latin)`` returns a string of characters encoded for the
+    custom Tengwar Annatar font included.  Paragraphs and sections are
+    encoded with new lines.
+-   ``transcribeHtml(latin)`` returns a string of HTML.  Stanzas,
+    paragraphs, and sections are encoded with HTML tags, ``br`` and
+    ``p``.
+-   ``annotate(latin)`` returns a multi-dimensional array that describes
+    the phoneme produced by each character and diacritic of the
+    corresponding elvish.
+-   ``annotateHtml(latin)`` returns an HTML table of the annotation
+    data.
+
+When used as a script, the API is planted in a ``tengwar`` global
+variable.
+
+If used as a jQuery plugin, you can use the "tengwar" method to
+transcribe the contents of selected tags and add the "tengwar" class
+to successfully transcribed tags.
+
+    $("transcribe-tengwar").tengwar();
+
+Be sure to use the included web font, derrived from Johan Winge's
+Tengwar Annatar.  It is customized for this web-deployed transcriber.
+
+If used as a Node module, the ``tengwar`` module exports the API.
+