Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contributing details #106

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions CONTRIBUTORS

This file was deleted.

7 changes: 7 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -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)
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<your_username>/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

Expand Down
2 changes: 1 addition & 1 deletion bookmarklet.js
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
Expand Down