clean up manifest
[newtab.git] / README.md
index cf62fe49ee1e4b6b045d8f644804a73a45c09c8e..35d97d0450c81c51ed1863a8728fe2b10615e2a6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,30 +1,19 @@
-NOTE: This is the original README from Start Clean New Tab Page Lite.
-      All I did was add in the display of website favicons and all new tabs forced
-      open in a new tab upon left click.
-      
-Original git repo:  https://github.com/startclean/Chrome-Extension
+After Google changed the new tab page of Chrome to an ugly array of circular icons (around mid 2016), I looked around for a better new tab page extension. The best I could find was [Start Clean](https://startclean.github.io/), but it had several issues (I don't remember exactly - I think there were various bugs). A fork of Start Clean by [shadowfax](https://startclean.github.io/) fixed some small issues and added the favicons which was rather nice, but for some reason (???) this fork makes links open in a new tab.
 
-# Start Clean New Tab Page Lite
+Initially I forked shadowfax's version to make links open in the current tab. That worked fine for a while, but I have since rewritten the extension to have much more flexibility in adding/removeing links and categories. The UI is also much improved. Here is a summary of the changes I've made:
 
-Start Clean Light is a version of the extension with no search.
-Start Clean offers a minimal ui that replaces Google Chrome's default page. It includes the top sites you visit, and can show your apps. You can add your own custom links and drag to reorder.
+* Links open in the current tab
+* Background, foreground and hover colours are configurable
+* Removed ueslesss search bar and apps sections (all I want is links to common sites)
+* You can now have as many columns of links as you like
+* Added new "edit mode" where you can rearrange/add/remove/rename columns
+* Added basic keyboard shortcuts & tab indices
+- Uses browser-default sans serif font rather than locally packaged font
+- Improved settings UI
+- Much cleaner code (well, it is Javascript after all)
 
- * Version 0.2.7 bundles code and fonts locally for offline usage.
- * Version 0.2.6 offers a background color changer in the options. Thank you to koopa1338 on github! 
- * Version 0.2.5 includes bug fixes. 
- * Version 0.2.4 changes the way search works with autocomplete powered by duckduckgo and wikipedia. 
- * Version 0.2.2 offers an option to choose search box location and search engine & urls in the search box resolve. 
+## Installation
 
-[Donate to dev](https://www.paypal.me/rawas)
+This extension isn't available on the Chrome Web Store because I can't be bothered figuring out how that works. To install it as a local extension, download `bin/newtab.crx` then drag it onto the extensions page at <chrome://extensions>. Developer mode must be enabled on the extensions page before doing this.
 
-![](http://i.imgur.com/PnM9k1S.png)
-
-![](http://i.imgur.com/bHBfXLk.png)
-
-![](http://i.imgur.com/mIm30O8.png)
-
-Start Clean New Tab Page has less features and options than alternatives such as Awesome New Tab Page, but it is cleaner, faster, and has only what you need.
-
-Use Start Clean with your linux desktop to spice it up even more!
-
-![](http://i.imgur.com/UV9KV8N.jpg)
+Also, opening the file using Chrome's file handler causes a "CRX_REQUIRED_PROOF_MISSING" error because I haven't updated the manifest to CRX3 (that's on the todo list). So for the moment you have to drag and drop it onto the extension page and that seems to bypass the verification. More info [here](https://support.google.com/chrome/thread/3125155?hl=en).