documentcloud · reefdog · Apr 29, 2015 · Apr 16, 2015 · Apr 17, 2015 · Apr 18, 2015
diff --git a/README.md b/README.md
@@ -0,0 +1,87 @@
+# DocumentCloud WordPress plugin
+
+The DocumentCloud WordPress plugin lets you embed [DocumentCloud](https://www.documentcloud.org/) resources into WordPress content using [shortcodes](https://codex.wordpress.org/Shortcode_API).
+
+    [documentcloud url="https://www.documentcloud.org/documents/282753-lefler-thesis.html"]
+
+## Installation
+
+1. Upload the contents of the plugin to `wp-content/plugins/documentcloud`
+2. Activate the plugin through the "Plugins" menu
+3. In your posts, embed documents or notes using the DocumentCloud button or the `[documentcloud]` shortcode
+4. Optional: Set a default width/height for all DocumentCloud embeds (which can be overridden on a per-embed basis with the `height/width` attributes) at Settings > DocumentCloud. (This default width will only be used if you set `responsive="false"` on an embed.)
+
+## Usage
+
+This plugin allows you embed DocumentCloud resources using a custom shortcode:
+
+    [documentcloud url="https://www.documentcloud.org/documents/282753-lefler-thesis.html"]
+
+When you save, WordPress fetches and stores the actual embed code HTML from the DocumentCloud servers using oEmbed. You can freely toggle between visual and HTML mode without mangling embed code, and your embed will always be up to date with the latest embed code.
+
+By default, documents will have a responsive width (it will narrow and widen as necessary to fill available content area) and use the theme's default height. If you want to override this, you can either set `responsive="false"` or explicitly set a `width`:
+
+    [documentcloud url="https://www.documentcloud.org/documents/282753-lefler-thesis.html" width="600"]
+
+You can set your own defaults in Settings > DocumentCloud, but default widths will be ignored unless `responsive` is disabled:
+
+    [documentcloud url="https://www.documentcloud.org/documents/282753-lefler-thesis.html" responsive="false"]
+
+To embed a note, just use any note-specific URL. Notes ignore `width/height` and always act responsively:
+
+    [documentcloud url="https://www.documentcloud.org/documents/282753-lefler-thesis.html#document/p1/a53674"]
+
+Here's the full list of embed options you can pass via shortcode attributes; some are specific to the type of resource you're embedding.
+
+### All resources (documents and notes):
+
+- `url` (**required**, string): Full URL of the DocumentCloud resource.
+- `container` (string): ID of element to insert the embed into; if excluded, embedder will create its own container.
+
+### Documents only:
+
+- `height` (integer): Height (in pixels) of the embed.
+- `width` (integer): Width (in pixels) of the embed. If used, will implicitly set `responsive="false"`.
+- `responsive` (boolean): Use responsive layout, which dynamically adjusts width to fill content area. Defaults `true`.
+- `responsive_offset` (integer): Distance (in pixels) to vertically offset the viewer for some responsive embeds.
+- `default_page` (integer): Page number to have the document scroll to by default.
+- `default_note` (integer): ID of the note that the document should highlight by default.
+- `notes` (boolean): Show/hide notes:
+- `search` (boolean): Hide or show search form.
+- `sidebar` (boolean): Hide or show sidebar. Defaults `false`.
+- `pdf` (boolean): Hide or show link to download original PDF. Defaults `true`.
+- `text` (boolean): Hide or show text tab. Defaults `true`.
+- `zoom` (boolean): Hide or show zoom slider.
+- `format` (string): Indicate to the theme that this is a wide asset by setting this to `wide`. Defaults `normal`.
+
+You can read more about publishing and embedding DocumentCloud resources on https://www.documentcloud.org/help/publishing.
+
+## Caching
+
+Ideally, when WordPress hits our oEmbed service to fetch the embed code, it would obey the `cache_age` we return. Despite [conversation](https://core.trac.wordpress.org/ticket/14759) around this, it doesn't seem to.
+
+Instead, it lets us choose between no cache at all (so *every pageload* triggers a call to our oEmbed service to get the embed code) or a supposed 24-hour cache stored in the `postmeta` table. Unfortunately, [our tests](https://github.com/documentcloud/wordpress-documentcloud/issues/20) seem to show this cache is never expired, which means we can choose between no cache (thus possibly DDOSing ourselves) or a permanent cache (thus possibly having stale embed codes). We've chosen the latter; hopefully this cache does eventually expire, and our embed codes shouldn't change that often anyway.
+
+If you find yourself absolutely needing to expire the cache, though, you have two choices:
+
+1. Delete the appropriate `_oembed_*` rows from your `postmeta` table.
+2. Modify the shortcode attributes for the embed, since this is recognized as a new embed by WordPress.
+
+## Changelog
+
+### 0.3
+* Add support for embedding notes.
+* Default to responsive.
+* Enable caching.
+
+### 0.2
+* Fetch embed code via oEmbed instead of generating statically.
+* Add new options: `container`, `responsive`, `responsive_offset`, `default_page`, `default_note`, `notes`, `search`, and `zoom`.
+* Deprecate `id` attribute. It's still usable, but support may drop in the future. Use `url` instead.
+
+### 0.1
+* Initial release.
+
+## License and History
+
+The DocumentCloud WordPress plugin is [GPLv2](http://www.gnu.org/licenses/gpl-2.0.html). Initial development of this plugin by Chris Amico (@eyeseast) supported by [NPR](http://www.npr.org) as part of [StateImpact](http://stateimpact.npr.org) project. Development continued by Justin Reese (@reefdog) at [DocumentCloud](https://www.documentcloud.org/).