Skip to content

Commit

Permalink
improves getting started docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stubbornella committed Dec 18, 2013
1 parent cef4635 commit d362423
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.md
Expand Up @@ -19,18 +19,27 @@ A browser (firebug, currently) extension that counts all the fonts on a page and

Getting Started
---------------
To try it on your site:

### Installing the Extension

1. Download and install the Firebug extension to Firefox
2. Download and install the Typo-o-matic extension to Firebug (I know, I fully intend to port it to Chrome)
3. Now, visit the site you’d like to test 
4. Right click and choose Inspect element with Firebug
5. Now click on the typography tab
6. Click Persist
7. Click Generate Report
8. Choose which pages to analyze (we’ve found that ten is a good number to get the big picture, but you can analyze as many as you’d like — it will even work on just one page!)
9. Now navigate to other pages, and on each subsequent page, click Generate Report
10. The table of results can be a bit difficult to interact with, so you can always click Copy to clipboard, and copy the results (JSON).

### Using the extension
1. Now, visit the site you’d like to test 
2. Right click and choose *Inspect element with Firebug*
3. Now click on the *Typography* tab
4. Click *Generate Report*

You'll see a list of different font properties and how many times they were used on the pages you've analyzed.

### Analyzing multiple pages

1. Choose which pages to analyze (we’ve found that ten is a good number to get the big picture, but you can analyze as many as you’d like — it will even work on just one page!)
2. Click *Persist*
3. Now navigate to other pages, and on each subsequent page, click *Generate Report*

You'll see the list of values and the count grow with each page. The table of results can be a bit difficult to interact with, so you can always click Copy to clipboard, and copy the results (JSON).

Next Steps
----------
Expand Down

0 comments on commit d362423

Please sign in to comment.