Skip to content

Commit

Permalink
Added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
eyeseast committed Jan 20, 2011
1 parent d7ad0fa commit 1edfc6c
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
@@ -0,0 +1,28 @@
A JavaScript (actually CoffeeScript) Document Viewer
===============

This is an attempt to build a portable document library and viewer entirely client-side, using the public [API](http://documentcloud.org/api) provided by [DocumentCloud](http://documentcloud.org).

Getting started:

Clone or download from this repository. Include on your page the following dependencies:

- [jQuery](http://jquery.com)
- [underscore.js](https://github.com/documentcloud/underscore)
- [backbone.js](https://github.com/documentcloud/backbone)
- documents.js

(At some point in the future, I'll probably package everything into one download using [Jammit](https://github.com/documentcloud/jammit). For now, you're stuck with dependencies.)

Embed:

<div id="documents"></div>
<script>
var docs = new DocumentViewer({
q: "group:homicide-watch",
per_page: 12,
page: 1
})
</script>

See [DocumentCloud's API documentation](http://documentcloud.org/api) for arguments.

0 comments on commit 1edfc6c

Please sign in to comment.