diff --git a/CONTRIBUTORS b/CONTRIBUTORS deleted file mode 100644 index f7d8029..0000000 --- a/CONTRIBUTORS +++ /dev/null @@ -1,4 +0,0 @@ -@cameron -@plentz -@nslater -@clarkf \ No newline at end of file diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 0000000..2314c24 --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,7 @@ +Project contributors: + +* [@cameron](https://github.com/cameron) +* [@plentz](https://github.com/plentz) +* [@nslater](https://github.com/nslater) +* [@clarkf](https://github.com/clarkf) +* [@mihai](https://github.com/mihai) diff --git a/README.md b/README.md index 69a199a..51d2339 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,23 @@ A speed reading bookmarklet. - gorgeous - no external API dependencies +## Contributing + +If you want to contribute to this project, follow the below steps to set up +Squirt for local development: + +* fork this repository +* clone your fork locally +``` +git clone https://github.com//squirt +``` +* start a http server in the repo's folder, for example: +``` +python -m SimpleHTTPServer 4000 +``` +* navigate to the website you want to test Squirt on and append `?sq-dev` to the + URL, which will instruct the bookmarklet to use your local files +* open the bookmarklet from the bookmarks bar ## Sister Projects diff --git a/bookmarklet.js b/bookmarklet.js index 1c9aa3a..7a47528 100644 --- a/bookmarklet.js +++ b/bookmarklet.js @@ -11,7 +11,7 @@ if(s.idx != -1){ s.ampIdx = s.s.indexOf('&', s.idx); s.host = s.s.substring(s.idx + 7, s.ampIdx == -1 ? s.s.length : s.ampIdx); - s.src = 'http://' + (s.host ? s.host : 'localhost') + ':4000/bm/squirt.js'; + s.src = 'http://' + (s.host ? s.host : 'localhost') + ':4000/squirt.js'; } document.body.appendChild(s); }