Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |