Update read me to add changelog

README.md

@@ -13,11 +13,15 @@ Browser extensions (Chrome, Firefox and Safari) to display GitHub code in tree f
 ![When extension is active](https://raw.githubusercontent.com/buunguyen/octotree/master/docs/chrome.png)
 
 ## Install on Firefox and Safari
-I'm in the process of submitting the extensions to Mozilla and Safari stores. Meanwhile, you can install the prebuilt extensions located in the [dist](https://github.com/buunguyen/octotree/tree/master/dist) folder.
+Submitting to Mozilla and Safari stores is quite a tedious process. Octotree 1.0 (not even 1.1) was submitted to Mozilla store and is still being reviewed. Safari store requires even more work and time (that I don't have). 
+
+Alternatively, you can just install the prebuilt extensions located in the [dist](https://github.com/buunguyen/octotree/tree/master/dist) folder. For security reason, be sure to install from this location only. 
 
 * Firefox: drag `octotree.xpi` to the browser and follow the instructions
 * Safari: drag `octotree.safariextz` to the browser and follow the instructions
 
+Note: you can also pack extensions from source by executing the Gulp script that generates extension structures for Chrome, Firefox and Safari. Refer to the documentation of [Firefox](https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_started) and [Safari](https://developer.apple.com/library/safari/documentation/tools/conceptual/safariextensionguide/UsingExtensionBuilder/UsingExtensionBuilder.html#//apple_ref/doc/uid/TP40009977-CH2-SW1) to learn how to package extensions.
+
 ## GitHub API Rate Limit
 Octotree uses [GitHub API](https://developer.github.com/v3/) to retrieve repository metadata. By default, it makes unauthenticated requests to the GitHub API. However, there are two situations when requests must be authenticated:
 
@@ -34,19 +38,21 @@ Alternatively, you can manually enter or update the token by following these ste
 * Open the Chrome (or Safari, Firefox) developer console
 * Execute the following line:
 ```javascript
-localStorage.setItem('octotree.github_access_token', JSON.stringify('REPLACE WITH TOKEN'))
+localStorage.setItem('octotree.github_access_token', 'REPLACE WITH TOKEN')
 ```
 
-## Contribution
-There are several improvements that can be made to Octotree. Contribution is very welcome.
+## Changelog
+### v1.1
+* New UI that blends better with GitHub! https://github.com/buunguyen/octotree/pull/43
+* Hide Octotree on non-code pages https://github.com/buunguyen/octotree/pull/44, https://github.com/buunguyen/octotree/pull/42, https://github.com/buunguyen/octotree/pull/52 
+* When asking for token, show more detailed message and not fly out automatically https://github.com/buunguyen/octotree/commit/96ff6196bb99aa36ae8bf08c345354fcd4db79a1
+* Extend pjax timeout to work better with big files https://github.com/buunguyen/octotree/commit/4d5f526a719191d7f756443c60f471f1c775f8c8
+* Sanitize file and folder names before displaying https://github.com/buunguyen/octotree/commit/a1e8a63ca894d4ecc58ba722727ca8b3c1a2128d
+* Fix error when a branch name contains slashes https://github.com/buunguyen/octotree/pull/12
+* Gulp script to build for Chrome, Firefox and Safari https://github.com/buunguyen/octotree/commit/c485b144a3d6a9114148e7ca8e2fe4ce0d74b1c4, https://github.com/buunguyen/octotree/commit/61a9e8af864365df4ece208f213a3d49d241de0e
+* And some other minor changes
 
-- [ ] Hide sidebar when navigating to non-code pages like Issues, PRs...
-- [ ] Make the width of the sidebar resizable.
-- [ ] Allow docking sidebar to either the left or right side.
-- [ ] Allow users to enter access token any time.
-- [ ] Synchronize (two-way) between sidebar selection and GitHub selection.
-- [ ] Show progress indicator while the code tree or a file is being loaded (with Pjax). (Showing spinner in the toggle button?)
 
 ## Credit
-* [Icon](https://github.com/pstadler/octofolders) by [pstadler](https://github.com/pstadler)
-* Thanks to many people submitting pull requests, reporting bugs and suggesting ideas here and on [HN](https://news.ycombinator.com/item?id=7740226)
+* Thanks to everyone who submit pull requests, report bugs and suggest ideas on GitHub and on [HN](https://news.ycombinator.com/item?id=7740226)
+* [Extension icon](https://github.com/pstadler/octofolders) by [pstadler](https://github.com/pstadler)

src/inject.js

@@ -38,7 +38,7 @@
     loadRepo()
 
     // When navigating from non-code pages (i.e. Pulls, Issues) to code page
-    // GitHub doesn't reload the page but use pjax. Need to detect and load Octotree.
+    // GitHub doesn't reload the page but uses pjax. Need to detect and load Octotree.
     var href = location.href
       , hash = location.hash
     function detectLocationChange() {
@@ -120,7 +120,7 @@
         else if (type === 'blob') {
           item.a_attr = { href: url }
         }
-        // TOOD: handle submodule
+        // TOOD: handle submodule, anyone?
       })
 
       done(null, sort(root))
@@ -144,20 +144,20 @@
       , message
 
     if (err.error === 401) {
-      header = 'Invalid token!'
+      header  = 'Invalid token!'
       message = 'The token is invalid. Follow <a href="https://github.com/settings/tokens/new" target="_blank">this link</a> to create a new token and paste it in the textbox below.'
     }
 
     else if (err.error === 404) {
       header = 'Private or invalid repository!'
       if (hasToken) message = 'You are not allowed to access this repository.'
-      else message = 'Accessing private repositories requires a GitHub access token. Follow <a href="https://github.com/settings/tokens/new" target="_blank">this link</a> to create one and paste it in the textbox below.'
+      else          message = 'Accessing private repositories requires a GitHub access token. Follow <a href="https://github.com/settings/tokens/new" target="_blank">this link</a> to create one and paste it in the textbox below.'
     }
 
     else if (err.error === 403 && ~err.request.getAllResponseHeaders().indexOf('X-RateLimit-Remaining: 0')) {
       header = 'API limit exceeded!'
       if (hasToken) message = 'Whoa, you have exceeded the API hourly limit, please create a new access token or take a break :).'
-      else message = 'You have exceeded the GitHub API hourly limit and need GitHub access token to make extra requests. Follow <a href="https://github.com/settings/tokens/new" target="_blank">this link</a> to create one and paste it in the textbox below.'
+      else          message = 'You have exceeded the GitHub API hourly limit and need GitHub access token to make extra requests. Follow <a href="https://github.com/settings/tokens/new" target="_blank">this link</a> to create one and paste it in the textbox below.'
     }
 
     updateSidebar('<div class="octotree_header_error">' + header + '</div>', message)