Skip to content

Commit

Permalink
README tweaks.
Browse files Browse the repository at this point in the history
  • Loading branch information
joseph committed Sep 5, 2011
1 parent 6ff8d5c commit edebb69
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Contributions welcome - fork the repository on
## Getting Monocle

You can download a unified, redistributable version of Monocle
[from Github](https://github.com/joseph/Monocle/archives/master).
[from Github](https://github.com/joseph/Monocle/downloads).

The scripts and stylesheets are separated into:

Expand All @@ -25,7 +25,7 @@ It's recommended that you develop against the unminified files, to make
debugging easier. In production, use the minified files.


## Getting started
## Integrating Monocle

Here's the simplest thing that could possibly work.

Expand Down Expand Up @@ -56,14 +56,15 @@ A more advanced scenario involves feeding Monocle a "book data object", from
which it can lazily load the contents of the book as the user requests it.


## Try some examples
## Exploring Monocle

The best way to gain a quick understanding of Monocle is to clone this
repository, and open `index.html` in the `test` directory. This gives you
an overview of the main example tests and feature tests.
If you want to explore all of Monocle's features, clone this repository and
open `test/index.html` in your browser. This will guide you through Monocle's
tests, which incidentally demonstrate all the major features. View source or
browse the test directory in your text editor for implementation details.


## The book data object
## Connecting Monocle to your book content

For a non-trivial Monocle implementation, your task is to connect the
Monocle Reader to your book's HTML content and structure. You create
Expand Down Expand Up @@ -119,7 +120,7 @@ If you can help out with any of these things, fork away (or contact 'joseph'
on GitHub).


### History
## History

2.1.0 - Source file reorganisation, Sprockets 2, distributables, wiki.

Expand Down

0 comments on commit edebb69

Please sign in to comment.