Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Moved the changelog into the History.md file

  • Loading branch information...
commit 3263e7ef81becd07ed45f7729d73b2a4694e68d6 1 parent de8554b
Benjamin Arthur Lupton authored

Showing 2 changed files with 84 additions and 87 deletions. Show diff stats Hide diff stats

  1. 76  History.md
  2. 95  README.md
76  History.md
Source Rendered
... ...
@@ -0,0 +1,76 @@
  1
+## History
  2
+
  3
+- v1.7.1 - October 4 2011
  4
+	- Added a new native adapter which is framework agnostic (can be used with, or without any framework)
  5
+	- Provided bundled files
  6
+	- Added RightJS adapter
  7
+	- Updated supported browser listing
  8
+	- Added sessionStorage support in core instead of optional Amplify.js Store support
  9
+	- Fixed issue with state id generation growing slower over time
  10
+	- Closes #104, #95, #102, #92, #81, #90, #94, #93, #91, #67, #83, #54, #45
  11
+
  12
+- v1.7.0 - April 1 2011
  13
+	- 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`.
  14
+	- 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)
  15
+	- 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/)
  16
+	- 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)
  17
+	- Fixed URL Encoding Issue - [Reported](https://github.com/balupton/history.js/issues/#issue/33) by [Rob Madole](http://robmadole.com/)
  18
+	- 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/)
  19
+	- URLs in the State Hashes for HTML4 Browsers are now even shorter - [Discussion](https://github.com/balupton/history.js/issues#issue/28)
  20
+	- Fixed a issue with the MooTools Adapter and JSON with IE7 and IE8
  21
+
  22
+- v1.6.0 - March 22 2011
  23
+	- Added Zepto adapter thanks to [Matt Garrett](http://twitter.com/#!/matthewgarrett)
  24
+	- The readme now references the supported versions of the libraries we use
  25
+	- Updated vendors to the most recent versions. jQuery 1.5.1 and Mootools 1.3.1
  26
+	- Reverted versions of Safari iOS prior to version 4.3 to be HTML4 browsers, Safari iOS 4.3 is a HTML5 browser
  27
+	- Refined code in History.js and its adapters
  28
+	- 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/)
  29
+	- 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)
  30
+	- 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)
  31
+	- 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/)
  32
+	- 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/)
  33
+	- **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.
  34
+
  35
+- v1.5.0 - February 12 2011
  36
+	- Moved to UglifyJS instead of Google Closure
  37
+	- Split HTML4 functionality from HTML5 functionality
  38
+	- Installation details have changed (the filenames are different)
  39
+
  40
+- v1.4.1 - February 10 2011
  41
+	- Added HTML History API Support for Safari 5 and Safari iOS 4.2.1
  42
+	- Cleaned code a bit (mostly with unit tests)
  43
+
  44
+- v1.4.0 - February 10 2011
  45
+	- Unit Testing now uses [QUnit](http://docs.jquery.com/Qunit)
  46
+	- Corrected Safari 5 Support
  47
+	- Now uses queues instead of timeouts
  48
+		- This means the API works exactly as expected, no more need to wrap calls in timeouts
  49
+	- Included a Subscribe Form in the Demo for Version Updates via Email
  50
+	- Small updates to Documentation
  51
+
  52
+- v1.3.1 - February 4 2011
  53
+	- Improved Documentation
  54
+
  55
+- v1.3.0 - January 31 2011
  56
+	- Support for cleaner HTML4 States
  57
+
  58
+- v1.2.1 - January 30 2011
  59
+	- Fixed History.log always being called - [reported by dlee](https://github.com/balupton/history.js/issues/#issue/2)
  60
+	- Re-Added `History.go(index)` support
  61
+
  62
+- v1.2.0 - January 25 2011
  63
+	- Support for HTML4 States in HTML5 Browsers (added test)
  64
+	- Updates of Documentation
  65
+
  66
+- v1.1.0 - January 24 2011
  67
+	- Developed a series of automated test cases
  68
+	- Fixed issue with traditional anchors
  69
+	- Fixed issue with differing replaceState functionality in HTML4 Browsers
  70
+	- Fixed issue with Google Chrome artefacts being carried over to the initial state
  71
+	- Provided `onstatechange` and `onanchorchange` events
  72
+
  73
+- v1.0.0 - January 22 2011
  74
+	- Supported `History.pushState` and `History.replaceState` degradation
  75
+	- Supported jQuery, MooTools and Prototype Frameworks
  76
+
95  README.md
Source Rendered
... ...
@@ -1,7 +1,7 @@
1 1
 Welcome to History.js (v1.7.1 - October 4 2011)
2 2
 ==================
3 3
 
4  
-[![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) 
  4
+[![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)
5 5
 
6 6
 
7 7
 This project is the successor of [jQuery History](http://balupton.com/projects/jquery-history), it aims to:
@@ -13,7 +13,7 @@ This project is the successor of [jQuery History](http://balupton.com/projects/j
13 13
 - 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/)
14 14
 
15 15
 Licensed under the [New BSD License](http://opensource.org/licenses/BSD-3-Clause)
16  
-Copyright 2011 [Benjamin Arthur Lupton](http://balupton.com)
  16
+<br/>Copyright &copy;  2011-2012 [Benjamin Arthur Lupton](http://balupton.com)
17 17
 
18 18
 
19 19
 ## Usage
@@ -121,7 +121,7 @@ To ajaxify your entire website with the HTML5 History API, History.js and jQuery
121 121
 		``` html
122 122
 		<script src="http://www.yourwebsite.com/history.js/scripts/bundled/html4+html5/right.history.js"></script>
123 123
 		```
124  
-	
  124
+
125 125
 	- For [Zepto](http://zeptojs.com/) v0.5+
126 126
 
127 127
 		``` html
@@ -236,87 +236,8 @@ Thanks! every bit of help really does make a difference. Again thank you.
236 236
 	- Mercury iOS fails to apply url changes (hashes and HTML5 History API states) - there is nothing we can do about this
237 237
 
238 238
 
239  
-## Changelog
240  
-
241  
-- v1.7.1 - October 4 2011
242  
-	- Added a new native adapter which is framework agnostic (can be used with, or without any framework)
243  
-	- Provided bundled files
244  
-	- Added RightJS adapter
245  
-	- Updated supported browser listing
246  
-	- Added sessionStorage support in core instead of optional Amplify.js Store support
247  
-	- Fixed issue with state id generation growing slower over time
248  
-	- Closes #104, #95, #102, #92, #81, #90, #94, #93, #91, #67, #83, #54, #45
249  
-
250  
-- v1.7.0 - April 1 2011
251  
-	- 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`.
252  
-	- 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)
253  
-	- 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/)
254  
-	- 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)
255  
-	- Fixed URL Encoding Issue - [Reported](https://github.com/balupton/history.js/issues/#issue/33) by [Rob Madole](http://robmadole.com/)
256  
-	- 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/)
257  
-	- URLs in the State Hashes for HTML4 Browsers are now even shorter - [Discussion](https://github.com/balupton/history.js/issues#issue/28)
258  
-	- Fixed a issue with the MooTools Adapter and JSON with IE7 and IE8
259  
-
260  
-- v1.6.0 - March 22 2011
261  
-	- Added Zepto adapter thanks to [Matt Garrett](http://twitter.com/#!/matthewgarrett)
262  
-	- The readme now references the supported versions of the libraries we use
263  
-	- Updated vendors to the most recent versions. jQuery 1.5.1 and Mootools 1.3.1
264  
-	- Reverted versions of Safari iOS prior to version 4.3 to be HTML4 browsers, Safari iOS 4.3 is a HTML5 browser
265  
-	- Refined code in History.js and its adapters
266  
-	- 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/)
267  
-	- 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)
268  
-	- 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)
269  
-	- 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/)
270  
-	- 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/)
271  
-	- **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.
272  
-
273  
-- v1.5.0 - February 12 2011
274  
-	- Moved to UglifyJS instead of Google Closure
275  
-	- Split HTML4 functionality from HTML5 functionality
276  
-	- Installation details have changed (the filenames are different)
277  
-
278  
-- v1.4.1 - February 10 2011
279  
-	- Added HTML History API Support for Safari 5 and Safari iOS 4.2.1
280  
-	- Cleaned code a bit (mostly with unit tests)
281  
-
282  
-- v1.4.0 - February 10 2011
283  
-	- Unit Testing now uses [QUnit](http://docs.jquery.com/Qunit)
284  
-	- Corrected Safari 5 Support
285  
-	- Now uses queues instead of timeouts
286  
-		- This means the API works exactly as expected, no more need to wrap calls in timeouts
287  
-	- Included a Subscribe Form in the Demo for Version Updates via Email
288  
-	- Small updates to Documentation
289  
-
290  
-- v1.3.1 - February 4 2011
291  
-	- Improved Documentation
292  
-
293  
-- v1.3.0 - January 31 2011
294  
-	- Support for cleaner HTML4 States
295  
-
296  
-- v1.2.1 - January 30 2011
297  
-	- Fixed History.log always being called - [reported by dlee](https://github.com/balupton/history.js/issues/#issue/2)
298  
-	- Re-Added `History.go(index)` support
299  
-
300  
-- v1.2.0 - January 25 2011
301  
-	- Support for HTML4 States in HTML5 Browsers (added test)
302  
-	- Updates of Documentation
303  
-
304  
-- v1.1.0 - January 24 2011
305  
-	- Developed a series of automated test cases
306  
-	- Fixed issue with traditional anchors
307  
-	- Fixed issue with differing replaceState functionality in HTML4 Browsers
308  
-	- Fixed issue with Google Chrome artefacts being carried over to the initial state
309  
-	- Provided `onstatechange` and `onanchorchange` events
310  
-
311  
-- v1.0.0 - January 22 2011
312  
-	- Supported `History.pushState` and `History.replaceState` degradation
313  
-	- Supported jQuery, MooTools and Prototype Frameworks
314  
-
315  
-
316  
-## Todo for Upcoming Releases
317  
-
318  
-- Allow for url to be optional in `pushState` and `replaceState` calls
319  
-- Add an Ajax extension to succeed the [jQuery Ajaxy](http://balupton.com/projects/jquery-ajaxy) project
320  
-- Add a compilation test to ensure `.debug = false` and no `History.log` or `console.xxx` calls exist.
321  
-
322  
-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.
  239
+
  240
+## History
  241
+
  242
+You can discover the history inside the [History.md](https://github.com/balupton/history.js/blob/master/History.md#files) file
  243
+

0 notes on commit 3263e7e

Please sign in to comment.
Something went wrong with that request. Please try again.