Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Comparing changes

Choose two branches to see what's changed or to start a new pull request. If you need to, you can also compare across forks.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also compare across forks.
base fork: balupton/history.js
...
head fork: balupton/history.js
  • 7 commits
  • 2 files changed
  • 0 commit comments
  • 1 contributor
Showing with 102 additions and 103 deletions.
  1. +76 −0 History.md
  2. +26 −103 README.md
View
76 History.md
@@ -0,0 +1,76 @@
+## History
+
+- v1.7.1 - October 4 2011
+ - Added a new native adapter which is framework agnostic (can be used with, or without any framework)
+ - Provided bundled files
+ - Added RightJS adapter
+ - Updated supported browser listing
+ - Added sessionStorage support in core instead of optional Amplify.js Store support
+ - Fixed issue with state id generation growing slower over time
+ - Closes #104, #95, #102, #92, #81, #90, #94, #93, #91, #67, #83, #54, #45
+
+- v1.7.0 - April 1 2011
+ - Added `History.enabled` property (refer to usage section). This reflects whether or not History.js is enabled for our particular browser. For instance, if we have not included support for a HTML4 browser and we are accessing through a HTML4 browser then `History.enabled` will be `false`.
+ - Added (optional but recommended) Data Persistance and Synchronisation Support thanks to [AppendTo's](http://appendto.com/) [Amplify.js](http://amplifyjs.com/) (refer to installation and compatibility sections for details)
+ - Made HTML5 SUIDs more transparent - [Reported](https://github.com/balupton/history.js/issues#issue/34) by [azago](https://github.com/azago) and [Mark Jaquith](http://markjaquith.com/)
+ - Fixed Session Storage Issue - Reported by a whole bunch of different people; [one](https://github.com/balupton/history.js/issues#issue/36), [two](https://github.com/balupton/history.js/issues#issue/37), [three](http://getsatisfaction.com/balupton/topics/history_js_1_6_losing_state_after_manual_page_reload)
+ - Fixed URL Encoding Issue - [Reported](https://github.com/balupton/history.js/issues/#issue/33) by [Rob Madole](http://robmadole.com/)
+ - Disabled support for IE6,7,8 when using the Prototype Adapter (there is nothing we can do about this, it is due to a bug in the prototype library) - [Reported](https://github.com/balupton/history.js/issues#issue/39) by [Sindre Wimberger](http://sindre.at/)
+ - URLs in the State Hashes for HTML4 Browsers are now even shorter - [Discussion](https://github.com/balupton/history.js/issues#issue/28)
+ - Fixed a issue with the MooTools Adapter and JSON with IE7 and IE8
+
+- v1.6.0 - March 22 2011
+ - Added Zepto adapter thanks to [Matt Garrett](http://twitter.com/#!/matthewgarrett)
+ - The readme now references the supported versions of the libraries we use
+ - Updated vendors to the most recent versions. jQuery 1.5.1 and Mootools 1.3.1
+ - Reverted versions of Safari iOS prior to version 4.3 to be HTML4 browsers, Safari iOS 4.3 is a HTML5 browser
+ - Refined code in History.js and its adapters
+ - Fixed issue with extra state being inserted on Safari 5 requiring an extra click on the back button to go home - [Reported](https://github.com/balupton/history.js/issues#issue/17) by [Rob Madole](http://robmadole.com/)
+ - Fixed issue with Safari 5 and Safari iOS 4 sometimes failing to apply the state change under busy conditions - Solution conceived with [Matt Garrett](http://twitter.com/matthewgarrett)
+ - Fixed issue with HTML4 browsers requiring a query-string in the urls of states - [Reported](https://github.com/balupton/history.js/issues#issue/26) by [azago](https://github.com/azago)
+ - Fixed issue with HTML4 browsers requiring title in the states in order to use state data - [Reported](https://github.com/balupton/history.js/issues#issue/25) by [Jonathan McLaughlin](http://system-werks.com/)
+ - Fixed issue with HTML4 browsers failing is a state is pushed/replaced twice in a row - [Reported](https://github.com/balupton/history.js/issues#issue/17) by [Joey Baker](http://byjoeybaker.com/)
+ - **B/C BREAK:** The `statechange` event now only fires if the state has changed; it no longer fires on page initialisation. This is following the [Firefox 4 History API Changes](http://hacks.mozilla.org/2011/03/history-api-changes-in-firefox-4/) which we agree with - this breaks standard, but makes more sense.
+
+- v1.5.0 - February 12 2011
+ - Moved to UglifyJS instead of Google Closure
+ - Split HTML4 functionality from HTML5 functionality
+ - Installation details have changed (the filenames are different)
+
+- v1.4.1 - February 10 2011
+ - Added HTML History API Support for Safari 5 and Safari iOS 4.2.1
+ - Cleaned code a bit (mostly with unit tests)
+
+- v1.4.0 - February 10 2011
+ - Unit Testing now uses [QUnit](http://docs.jquery.com/Qunit)
+ - Corrected Safari 5 Support
+ - Now uses queues instead of timeouts
+ - This means the API works exactly as expected, no more need to wrap calls in timeouts
+ - Included a Subscribe Form in the Demo for Version Updates via Email
+ - Small updates to Documentation
+
+- v1.3.1 - February 4 2011
+ - Improved Documentation
+
+- v1.3.0 - January 31 2011
+ - Support for cleaner HTML4 States
+
+- v1.2.1 - January 30 2011
+ - Fixed History.log always being called - [reported by dlee](https://github.com/balupton/history.js/issues/#issue/2)
+ - Re-Added `History.go(index)` support
+
+- v1.2.0 - January 25 2011
+ - Support for HTML4 States in HTML5 Browsers (added test)
+ - Updates of Documentation
+
+- v1.1.0 - January 24 2011
+ - Developed a series of automated test cases
+ - Fixed issue with traditional anchors
+ - Fixed issue with differing replaceState functionality in HTML4 Browsers
+ - Fixed issue with Google Chrome artefacts being carried over to the initial state
+ - Provided `onstatechange` and `onanchorchange` events
+
+- v1.0.0 - January 22 2011
+ - Supported `History.pushState` and `History.replaceState` degradation
+ - Supported jQuery, MooTools and Prototype Frameworks
+
View
129 README.md
@@ -1,7 +1,7 @@
Welcome to History.js (v1.7.1 - October 4 2011)
==================
-[![Flattr this project](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=balupton&url=https://github.com/balupton/history.js&title=History.js&language=&tags=github&category=software)
+[![Flattr this project](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=balupton&url=https://github.com/balupton/history.js&title=History.js&language=&tags=github&category=software)
This project is the successor of [jQuery History](http://balupton.com/projects/jquery-history), it aims to:
@@ -12,9 +12,6 @@ This project is the successor of [jQuery History](http://balupton.com/projects/j
- Provide a forwards-compatible experience for HTML4 States to HTML5 States (so if a hash-fallbacked url is accessed by a HTML5 browser it is naturally transformed into its non-hashed url equivalent)
- Provide support for as many javascript frameworks as possible via adapters; especially [jQuery](http://jquery.com/), [MooTools](http://mootools.net/), [Prototype](http://www.prototypejs.org/) and [Zepto](http://zeptojs.com/)
-Licensed under the [New BSD License](http://opensource.org/licenses/BSD-3-Clause)
-Copyright 2011 [Benjamin Arthur Lupton](http://balupton.com)
-
## Usage
@@ -100,9 +97,9 @@ To ajaxify your entire website with the HTML5 History API, History.js and jQuery
## Download & Installation
-1. Download History.js and upload it to your webserver. Download links: [tar.gz](https://github.com/balupton/history.js/tarball/master) or [zip](https://github.com/balupton/history.js/zipball/master)
+- Download History.js and upload it to your webserver. Download links: [tar.gz](https://github.com/balupton/history.js/tarball/master) or [zip](https://github.com/balupton/history.js/zipball/master)
-1. Include History.js
+- Include History.js
- For [jQuery](http://jquery.com/) v1.3+
@@ -121,7 +118,7 @@ To ajaxify your entire website with the HTML5 History API, History.js and jQuery
``` html
<script src="http://www.yourwebsite.com/history.js/scripts/bundled/html4+html5/right.history.js"></script>
```
-
+
- For [Zepto](http://zeptojs.com/) v0.5+
``` html
@@ -137,7 +134,7 @@ To ajaxify your entire website with the HTML5 History API, History.js and jQuery
> Note: If you want to only support HTML5 Browsers and not HTML4 Browsers (so no hash fallback support) then just change the `/html4+html5/` part in the urls to just `/html5/`. [Why supporting HTML4 browsers could be either good or bad based on my app's use cases](https://github.com/balupton/history.js/wiki/Intelligent-State-Handling)
-## Subscribe to Updates
+## Get Updates
- For Commit RSS/Atom Updates:
- You can subscribe via the [GitHub Commit Atom Feed](http://feeds.feedburner.com/historyjs)
@@ -145,23 +142,23 @@ To ajaxify your entire website with the HTML5 History API, History.js and jQuery
- You can click the "watch" button up the top right of History.js's [GitHub Project Page](https://github.com/balupton/history.js)
-## Getting Support
+## Get Support
-**History.js is an actively supported, maintained and developed project.** You can grab support via its **[GitHub Issue Tracker](https://github.com/balupton/history.js/issues)** and contact its core developer [Benjamin Lupton](http://balupton.com) via [twitter](http://twitter.com/balupton), skype (balupton) and email (b@lupton.cc). Benjamin is also available for [bookings](http://speakerrate.com/speakers/11963-benjamin-lupton) (trainings, seminars, talks), [consulting](http://careers.stackoverflow.com/balupton) (development, advisory), sponsorship (angels, investors, donations, advertisement), interviews, chats, hackathons, socials and mentoring.
+- History.js is maintained by people like you. If you find a bug, report it to the [GitHub Issue Tracker](https://github.com/balupton/history.js/issues). If you've fixed a bug submit a [Pull Request](https://github.com/balupton/history.js/pulls) and add your fork to the [Network Wiki Page](https://github.com/balupton/history.js/wiki/Network).
+- If you would like paid corporate support and trainings, or have job offers, then refer to the [Network Wiki Page](https://github.com/balupton/history.js/wiki/Network). If you are qualified with History.js, then be sure to add your details to that page too.
-## Giving Support
+- If you're company use History.js on your projects, and would like to see it grow and prosper (better documentation, bugfixes, upgrades, maintenance, etc.) and would love to become a corporate sponsor then do email sponsor@bevry.me
-If you'd love to give some support back and make a difference; here are a few great ways you can give back!
+- If you would like free support for History.js, then [post your question](http://stackoverflow.com/questions/ask) on [Stackoverflow](http://stackoverflow.com/about) and be sure to use the `history.js` tag when asking your question.
-- Give it your honest rating on its [jQuery Plugin's Page](http://plugins.jquery.com/project/history-js) and its [Ohloh Page](https://www.ohloh.net/p/history-js)
-- If you have any feedback or suggestions let me know via its [Issue Tracker](https://github.com/balupton/history.js/issues) - so that I can ensure you get the best experience!
-- Spread the word via tweets, blogs, tumblr, whatever - the more people talking about it the better!
-- [Make a donation](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=balupton%40gmail%2ecom&lc=AU&item_name=Donation%20to%20Benjamin%20Lupton&currency_code=AUD&bn=PP%2dDonationsBF%3adonate%2egif%3aNonHosted) - every cent truly does help!
-- Add your website or app which is using History.js to the [Showcase](https://github.com/balupton/history.js/wiki/Showcase)
-- Watch it via clicking the "watch" button up the top of its [Project Page](https://github.com/balupton/history.js)
+- If you've created a website that uses History.js, or know of one. Then be sure to add it to the [Showcase Wiki Page](https://github.com/balupton/history.js/wiki/Showcase).
-Thanks! every bit of help really does make a difference. Again thank you.
+- If you'd love to +1 or like this project, then be sure to tweet about it and click the "watch" button up the top of its [Project Page](https://github.com/balupton/history.js).
+
+- For anything else, refer to the [History.js GitHub Wiki Site](https://github.com/balupton/history.js/wiki).
+
+Thanks! every bit of help really does make a difference!
## Browsers: Tested and Working In
@@ -236,87 +233,13 @@ Thanks! every bit of help really does make a difference. Again thank you.
- Mercury iOS fails to apply url changes (hashes and HTML5 History API states) - there is nothing we can do about this
-## Changelog
-
-- v1.7.1 - October 4 2011
- - Added a new native adapter which is framework agnostic (can be used with, or without any framework)
- - Provided bundled files
- - Added RightJS adapter
- - Updated supported browser listing
- - Added sessionStorage support in core instead of optional Amplify.js Store support
- - Fixed issue with state id generation growing slower over time
- - Closes #104, #95, #102, #92, #81, #90, #94, #93, #91, #67, #83, #54, #45
-
-- v1.7.0 - April 1 2011
- - Added `History.enabled` property (refer to usage section). This reflects whether or not History.js is enabled for our particular browser. For instance, if we have not included support for a HTML4 browser and we are accessing through a HTML4 browser then `History.enabled` will be `false`.
- - Added (optional but recommended) Data Persistance and Synchronisation Support thanks to [AppendTo's](http://appendto.com/) [Amplify.js](http://amplifyjs.com/) (refer to installation and compatibility sections for details)
- - Made HTML5 SUIDs more transparent - [Reported](https://github.com/balupton/history.js/issues#issue/34) by [azago](https://github.com/azago) and [Mark Jaquith](http://markjaquith.com/)
- - Fixed Session Storage Issue - Reported by a whole bunch of different people; [one](https://github.com/balupton/history.js/issues#issue/36), [two](https://github.com/balupton/history.js/issues#issue/37), [three](http://getsatisfaction.com/balupton/topics/history_js_1_6_losing_state_after_manual_page_reload)
- - Fixed URL Encoding Issue - [Reported](https://github.com/balupton/history.js/issues/#issue/33) by [Rob Madole](http://robmadole.com/)
- - Disabled support for IE6,7,8 when using the Prototype Adapter (there is nothing we can do about this, it is due to a bug in the prototype library) - [Reported](https://github.com/balupton/history.js/issues#issue/39) by [Sindre Wimberger](http://sindre.at/)
- - URLs in the State Hashes for HTML4 Browsers are now even shorter - [Discussion](https://github.com/balupton/history.js/issues#issue/28)
- - Fixed a issue with the MooTools Adapter and JSON with IE7 and IE8
-
-- v1.6.0 - March 22 2011
- - Added Zepto adapter thanks to [Matt Garrett](http://twitter.com/#!/matthewgarrett)
- - The readme now references the supported versions of the libraries we use
- - Updated vendors to the most recent versions. jQuery 1.5.1 and Mootools 1.3.1
- - Reverted versions of Safari iOS prior to version 4.3 to be HTML4 browsers, Safari iOS 4.3 is a HTML5 browser
- - Refined code in History.js and its adapters
- - Fixed issue with extra state being inserted on Safari 5 requiring an extra click on the back button to go home - [Reported](https://github.com/balupton/history.js/issues#issue/17) by [Rob Madole](http://robmadole.com/)
- - Fixed issue with Safari 5 and Safari iOS 4 sometimes failing to apply the state change under busy conditions - Solution conceived with [Matt Garrett](http://twitter.com/matthewgarrett)
- - Fixed issue with HTML4 browsers requiring a query-string in the urls of states - [Reported](https://github.com/balupton/history.js/issues#issue/26) by [azago](https://github.com/azago)
- - Fixed issue with HTML4 browsers requiring title in the states in order to use state data - [Reported](https://github.com/balupton/history.js/issues#issue/25) by [Jonathan McLaughlin](http://system-werks.com/)
- - Fixed issue with HTML4 browsers failing is a state is pushed/replaced twice in a row - [Reported](https://github.com/balupton/history.js/issues#issue/17) by [Joey Baker](http://byjoeybaker.com/)
- - **B/C BREAK:** The `statechange` event now only fires if the state has changed; it no longer fires on page initialisation. This is following the [Firefox 4 History API Changes](http://hacks.mozilla.org/2011/03/history-api-changes-in-firefox-4/) which we agree with - this breaks standard, but makes more sense.
-
-- v1.5.0 - February 12 2011
- - Moved to UglifyJS instead of Google Closure
- - Split HTML4 functionality from HTML5 functionality
- - Installation details have changed (the filenames are different)
-
-- v1.4.1 - February 10 2011
- - Added HTML History API Support for Safari 5 and Safari iOS 4.2.1
- - Cleaned code a bit (mostly with unit tests)
-
-- v1.4.0 - February 10 2011
- - Unit Testing now uses [QUnit](http://docs.jquery.com/Qunit)
- - Corrected Safari 5 Support
- - Now uses queues instead of timeouts
- - This means the API works exactly as expected, no more need to wrap calls in timeouts
- - Included a Subscribe Form in the Demo for Version Updates via Email
- - Small updates to Documentation
-
-- v1.3.1 - February 4 2011
- - Improved Documentation
-
-- v1.3.0 - January 31 2011
- - Support for cleaner HTML4 States
-
-- v1.2.1 - January 30 2011
- - Fixed History.log always being called - [reported by dlee](https://github.com/balupton/history.js/issues/#issue/2)
- - Re-Added `History.go(index)` support
-
-- v1.2.0 - January 25 2011
- - Support for HTML4 States in HTML5 Browsers (added test)
- - Updates of Documentation
-
-- v1.1.0 - January 24 2011
- - Developed a series of automated test cases
- - Fixed issue with traditional anchors
- - Fixed issue with differing replaceState functionality in HTML4 Browsers
- - Fixed issue with Google Chrome artefacts being carried over to the initial state
- - Provided `onstatechange` and `onanchorchange` events
-
-- v1.0.0 - January 22 2011
- - Supported `History.pushState` and `History.replaceState` degradation
- - Supported jQuery, MooTools and Prototype Frameworks
-
-
-## Todo for Upcoming Releases
-
-- Allow for url to be optional in `pushState` and `replaceState` calls
-- Add an Ajax extension to succeed the [jQuery Ajaxy](http://balupton.com/projects/jquery-ajaxy) project
-- Add a compilation test to ensure `.debug = false` and no `History.log` or `console.xxx` calls exist.
-
-It's likely these features and/or others have been included in the latest [dev branch](https://github.com/balupton/history.js/tree/dev). If you are wanting to fork and help out, then be sure to work on the dev branch and not master.
+
+## History
+
+You can discover the history inside the [History.md](https://github.com/balupton/history.js/blob/master/History.md#files) file
+
+
+## License
+
+Licensed under the [New BSD License](http://opensource.org/licenses/BSD-3-Clause)
+<br/>Copyright &copy; 2011-2012 [Benjamin Arthur Lupton](http://balupton.com)

No commit comments for this range

Something went wrong with that request. Please try again.