Skip to content

Commit

Permalink
Added example link to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
mtrpcic committed Aug 1, 2011
1 parent cb3e2d1 commit 8f7dd06
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ PathJS is a lightweight, client-side routing library that allows you to create "
# Features #
* Lightweight
* Supports the HTML5 History API, the 'onhashchange' method, and graceful degredation
* Supports root routes, rescue methods, paramaterized routes, optional route components (dynamic routes), and Aspect Oriented Programming
* Well Tested (tests available in the `./tests` directory)
* Supports paramaterized routes, optional route components (dynamic routes), and Aspect Oriented Programming
* Compatible with all major browsers (Tested on Firefox 3.6, Firefox 4.0, Firefox 5.0, Chrome 9, Opera 11, IE7, IE8, IE9)
* Allows you to define root routes and rescue methods
* Independant of all third party libraries, but plays nice with all of them

# Using PathJS - A Brief Example #
Expand Down Expand Up @@ -36,6 +35,9 @@ PathJS is a lightweight, client-side routing library that allows you to create "
# Documentation and Tips #
Any of the examples above confuse you? Read up on the details in the [wiki](https://github.com/mtrpcic/pathjs/wiki).

# Examples #
You can find examples on the official [Github Page](http://mtrpcic.github.com/pathjs).

# Running Tests #
To run the tests, simply navigate to the `./tests` folder and open the HTML file in your browser. Please note that the HTML5 History API is not compatible with the
`file://` protocol, and to run the tests in the `tests/pushstate` folder, you will need to run them through a webserver such as nginx or Apache.
Expand Down

0 comments on commit 8f7dd06

Please sign in to comment.