Add documentation

Closes #6

Author: leoj3n

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing
+
+For general contributing guidelines, see the [Contributing Guide on DoneJS.com](https://donejs.com/contributing.html).
+
+## Project Organization
+
+    bit-docs-prettify
+    ├── bit-docs.js         # Registers this package into the bit-docs system as a dependency.
+    ├── prettify-engine.js  # The minified JavaScript for the prettify engine from google/code-prettify.
+    ├── prettify.js         # Bootstraps the prettify-engine.js and prettify.less files.
+    ├── prettify.less       # The "Tomorrow Night" syntax highlight theme.
+    └── test.js             # Creates temp/index.html with <pre><code>var str ='hello world';</code></pre>
+                            #   to verify that prettyprint gets applied after a timeout.
+
+## Developing Locally
+
+### Installing the dependencies
+
+Install the packages defined in [`package.json`](package.json):
+
+```shell
+npm install
+```
+
+### Running the tests
+
+Tests are located in [`test.js`](test.js), at the root of this repo.
+
+To run the tests, execute the `test` script defined in [`package.json`](package.json):
+
+```shell
+npm test
+```
+
+This will produce a directory and file at `temp/index.html`, containing the source-code snippet in HTML:
+
+```html
+<pre><code>var str ='hello world';</code></pre>
+```
+
+Running the tests will verify that this source-code snippet in HTML is correctly prettified by the plugin.
+
+In [`test.js`](test.js), the [bit-docs-generate-html](https://github.com/bit-docs/bit-docs-generate-html) plugin is generating HTML from the equivalent of this markdown:
+
+    ```
+    var str ='hello world';
+    ```
+
+That shows how a bit-docs "generator" plugin can generate the right HTML to play nice with `bit-docs-prettify`.
+
+You can open the file in your web browser to see the "pretty" result using `http-server`:
+
+```shell
+npm install -g http-server
+npm test && http-server
+```
+
+Now visit <http://127.0.0.1:8080/temp/index.html>
+
+## Getting Help
+
+[Our forums](http://forums.donejs.com) and [Gitter chat](https://gitter.im/donejs/donejs) are the best places to ask questions.

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 [Bitovi](http://bitovi.com)
+
+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.

README.md

@@ -1 +1,50 @@
 # bit-docs-prettify
+
+A [bit-docs](https://github.com/bit-docs/bit-docs) plugin that makes source-code snippets in HTML prettier.
+
+Powered by <https://github.com/google/code-prettify>.
+
+A working demonstration is available at <https://glitch.com/edit/#!/bit-docs-prettify>.
+
+## Usage
+
+Add `bit-docs-prettify` as a dependency to your project's `package.json`, under the `bit-docs` section:
+
+```json
+{
+  "name": "your-project",
+  ...
+  "bit-docs": {
+    "dependencies": {
+      "bit-docs-prettify": "*"
+    },
+    ...
+  }
+}
+```
+
+Now use the `bit-docs` command-line tool to install the added plugin dependency:
+
+```shell
+./node_modules/bit-docs/bin/bit-docs
+```
+
+Your project should now support syntax highlighting of source-code snippets in the following languages:
+
+    bsh, c, cc, cpp, cs, csh, cyc, cv, htm, html, java, js, m, mxml, perl, pl, pm, py, rb, sh, xhtml, xml, xsl 
+
+Use the following HTML code to trigger syntax highlighting of a source-code snippet:
+
+```html
+<pre><code class="language-java">...</code></pre>
+```
+
+You can replace `language-java` with an option from the list of supported languages above, like `language-js`.
+
+The code prettifier script will make an educated guess if you remove the `class="language-*"` declaration entirely.
+
+## Contributing
+
+Want to help make `bit-docs-prettify` even better? See [`CONTRIBUTING.md`](CONTRIBUTING.md).
+
+Looking for a changelog? Try the [releases page on GitHub](https://github.com/bit-docs/bit-docs-prettify/releases).