Permalink
Browse files

Readme

  • Loading branch information...
1 parent 4cb4408 commit 2bd7a0790e9fa69193dc6fc3ee40cb886441daec @wfarr committed Feb 20, 2011
Showing with 58 additions and 0 deletions.
  1. +58 −0 README.markdown
View
@@ -0,0 +1,58 @@
+..................... dotjs ........................
+
+dotjs is a Google Chrome extension that executes
+JavaScript files in `~/.js` based on their filename.
+
+If you navigate to `http://www.google.com/`, dotjs
+will execute `~/.js/google.com.js`.
+
+This makes it super easy to spruce up your favorite
+pages using JavaScript.
+
+Bonus: files in `~/.js` have jQuery 1.4.4 loaded,
+regardless of whether the site you're hacking
+uses jQuery.
+
+GreaseMonkey user scripts are great, but you need to
+publish them somewhere and re-publish after making
+modifications. With dotjs, just add or edit files in
+`~/.js`.
+
+## Example
+
+ $ cat ~/.js/github.com.js
+ // swap github logo with trollface
+ $('#header .logo img')
+ .css('width', '100px')
+ .css('margin-top', '-15px')
+ .attr('src', '//bit.ly/ghD24e')
+
+![](https://bit.ly/gAHTbC)
+
+## Installation
+
+1. Ensure you have defunkt's dotjs installed and running.
+2. Check out the downloads page and install the latest release.
+
+## How It Works
+
+The dotjs Safari extension then makes ajax requests
+to http://localhost:3131/convore.com.js any time you
+hit a page on convore.com, for example, and executes
+the returned JavaScript.
+
+## Requires
+
+- dotjs installed (https://github.com/defunkt/dotjs.git)
+- Safari
+
+## Credits
+
+- DotJS code: <https://github.com/defunkt/dotjs>
+- Icon: <http://raphaeljs.com/icons/>
+- jQuery: <http://jquery.com/>
+- Ryan Tomayko for:
+
+> "I almost wish you could just
+ stick JavaScript in ~/.js. Do
+ you know what I'm saying?"

0 comments on commit 2bd7a07

Please sign in to comment.