From 68e30c0bb738b3c0408c11e7f4e2a2e132c7f82b Mon Sep 17 00:00:00 2001 From: Ken Elf Mathieu Sternberg Date: Mon, 16 Jul 2012 12:12:29 -0700 Subject: [PATCH] Updated the README --- README.md | 71 ++++++++++++++++--------------------------------------- 1 file changed, 20 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index 1ac6209..08233d8 100644 --- a/README.md +++ b/README.md @@ -2,63 +2,32 @@ A simple program to show/hide priorities. -## Getting Started -Download the [production version][min] or the [development version][max]. +## Documentation A couple of weeks ago, I read an article in the +Harvard Business Review entitled Two Lists You Should Look At Every +Morning[1]. The first is the usual priority list: everything you care +about, that you want to spend your attention span on. The other, even +more important list, is everything you will ignore: everything that +distracts you, saps your time, that takes you away from your +achievements. To make a list of everything you do that, ultimately, +doesn't make you happy. -[min]: https://raw.github.com//PriorityIgnore/master/dist/PriorityIgnore.min.js -[max]: https://raw.github.com//PriorityIgnore/master/dist/PriorityIgnore.js +It was a solid idea, and I thought it would make a good variation on +RightNow!, my last "priority manager" that keeps list of everything +you care about. Like RightNow, Priority/Ignore uses your browser's +localstore to store its data: nothing is stored here, or anywhere +else, and every browser will have its own local store. If you use +more than one browser, this may present a problem, but most people +have one browser per device, and these lists shouldn't be that long. -In your web page: - -```html - - - -``` - -## Documentation -_(Coming soon)_ - -## Examples -_(Coming soon)_ - -## Release History -_(Nothing yet)_ +This is mostly a tech demo for various JS tools. ## License Copyright (c) 2012 Elf M. Sternberg Licensed under the CC-Attribution-NonCommercial-ShareAlike license. +I chose this license because this is more like content than coding. + ## Contributing -In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](https://github.com/cowboy/grunt). +In lieu of a formal styleguide, take care to maintain the existing +coding style. -### Important notes -Please don't edit files in the `dist` subdirectory as they are generated via grunt. You'll find source code in the `src` subdirectory! - -While grunt can run the included unit tests via PhantomJS, this shouldn't be considered a substitute for the real thing. Please be sure to test the `test/*.html` unit test file(s) in _actual_ browsers. - -### Installing grunt -_This assumes you have [node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed already._ - -1. Test that grunt is installed globally by running `grunt --version` at the command-line. -1. If grunt isn't installed globally, run `npm install -g grunt` to install the latest version. _You may need to run `sudo npm install -g grunt`._ -1. From the root directory of this project, run `npm install` to install the project's dependencies. - -### Installing PhantomJS - -In order for the qunit task to work properly, [PhantomJS](http://www.phantomjs.org/) must be installed and in the system PATH (if you can run "phantomjs" at the command line, this task should work). - -Unfortunately, PhantomJS cannot be installed automatically via npm or grunt, so you need to install it yourself. There are a number of ways to install PhantomJS. - -* [PhantomJS and Mac OS X](http://ariya.ofilabs.com/2012/02/phantomjs-and-mac-os-x.html) -* [PhantomJS Installation](http://code.google.com/p/phantomjs/wiki/Installation) (PhantomJS wiki) - -Note that the `phantomjs` executable needs to be in the system `PATH` for grunt to see it. - -* [How to set the path and environment variables in Windows](http://www.computerhope.com/issues/ch000549.htm) -* [Where does $PATH get set in OS X 10.6 Snow Leopard?](http://superuser.com/questions/69130/where-does-path-get-set-in-os-x-10-6-snow-leopard) -* [How do I change the PATH variable in Linux](https://www.google.com/search?q=How+do+I+change+the+PATH+variable+in+Linux)