# documentcloud-pages

This is a work in progress. Follow the development at this repo's [Github pages](http://documentcloud.github.io/documentcloud-pages/).

# Goals

A responsive, embeddable javascript library which displays pages from documents on DocumentCloud (or any other API compatible location).

# Why?

1. DocumentCloud's existing [document-viewer](https://github.com/documentcloud/document-viewer) doesn't play terribly well with mobile devices due to its pioneering nature (it was originally written in 2006 and has done a terrific job in the intervening time).
2. There are a number of use cases where it's useful just to display a single page from a document to support one's articles/arguments, and [DocumentCloud's note capabilities](http://www.documentcloud.org/help/notes) would complement this use of single pages of supporting material well.
3. DocumentCloud plans to incrementally build a responsive viewer from smaller constituent components, and a full page with notes is the next step up from [our smaller individual note embeds](http://www.documentcloud.org/help/notes).

# Participating

You should [open an issue](https://github.com/documentcloud/documentcloud-pages/issues) for suggestions or ideas you'd like to tell us about!

# Installation

TODO: explain this:

    bower install
    bundle install
    guard

# documentcloud-pages

This is a work in progress. Follow the development at this repo's [Github pages](http://documentcloud.github.io/documentcloud-pages/).

# Goals

A responsive, embeddable javascript library which displays pages from documents on DocumentCloud (or any other API compatible location).

# Why?

1. DocumentCloud's existing [document-viewer](https://github.com/documentcloud/document-viewer) doesn't play terribly well with mobile devices due to its pioneering nature (it was originally written in 2006 and has done a terrific job in the intervening time).
2. There are a number of use cases where it's useful just to display a single page from a document to support one's articles/arguments, and [DocumentCloud's note capabilities](http://www.documentcloud.org/help/notes) would complement this use of single pages of supporting material well.
3. DocumentCloud plans to incrementally build a responsive viewer from smaller constituent components, and a full page with notes is the next step up from [our smaller individual note embeds](http://www.documentcloud.org/help/notes).

# Participating

You should [open an issue](https://github.com/documentcloud/documentcloud-pages/issues) for suggestions or ideas you'd like to tell us about!

# Installing/building

To build, we use [Guard](https://github.com/guard/guard).

Install the dependencies with:

* `bower install` (See [bower.io](https://bower.io)).
* `bundle install` (See [bundler.io](http://bundler.io/))

To watch/build the project, run `guard`. The outputs will be built to [dist/](dist/).

Update readme with build instructions.
Update readme with build instructions.
