Skip to content

Commit

Permalink
Merge pull request #105 from nslater/new-website
Browse files Browse the repository at this point in the history
Create a GitHub Pages website for jetzt
  • Loading branch information
ds300 committed Mar 20, 2014
2 parents b0e9b20 + eca6bdd commit f4c6832
Show file tree
Hide file tree
Showing 6 changed files with 596 additions and 536 deletions.
51 changes: 9 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,30 @@
# jetzt

*jetzt* is a speed-reader extension for [chrome](http://google.com/chrome) inspired by [Spritz](http://www.spritzinc.com/).
*jetzt* is a speed-reader extension for [Chrome](http://google.com/chrome) inspired by [Spritz](http://www.spritzinc.com/).

### Screenshot

Here's what jetzt looks like in your browser:

![](screenshot.png)
![](img/screenshot.png)

### Installation
### More Info

This is very much beta software so a proper chrome extension package is not currently provided. Instead: clone this repository, then, in chrome, navigate to chrome://extensions , enable developer mode, click "Load unpacked extension..." and select the directory you cloned.
- Read about [how to install](https://ds300.github.io/jetzt/#install) (Chrome extension and bookmarklet)

Remember to pull every now and then for bugfixes and new features.
- Consult the [usage instructions](https://ds300.github.io/jetzt/#use).

### Usage

Control is currently keyboard-only.

- Initiate jetzt by pressing `alt`-`s` and clicking on the block of text you wish to read. Alternatively, select some text before pressing `alt`-`s`.

- Change size with `+`/`-`.

- Go faster/slower with up/down arrow keys.

- Go back/forward a sentence with left/right arrow keys (hold `alt` to navigate by paragraphs).

- Pause with space.

- Close with escape.

- Switch between light/dark themes with `0`

- Toggle statistics message with `/` or `?`

### Online Demo

[Here](http://ds300.github.com/jetzt/)

### Bookmarklet

You can also use it as a bookmarklet by:
- Copying the content of bookmarklet.js
- Manually adding a new bookmark
- Pasting the content into the location field.
- Check out the [online demo](http://ds300.github.com/jetzt/demo.html)

### ToDo

Check out the [ToDo](https://github.com/ds300/jetzt/wiki/ToDo) section of the wiki.

### Feature Requests/Contributions

Feel free to open an issue for anything you would like to see in jetzt, but have a quick look through the closed issues first to make sure it is not a duplicate request.
### Contributions

I also welcome pull requests of all shapes and sizes. Please submit to the dev branch, or to master if it is only a small bugfix. If it is your first time contributing to jetzt, please add your name to the list below (in alphabetical order).
Open an issue for anything you would like to see in jetzt, but please check other issues first.

Pull requests are welcome. Please submit to the `dev` branch, or to `master` if it is only a small bugfix. If it is your first time contributing to jetzt, please add your name to the list below (in alphabetical order).

### Contributors

Expand All @@ -68,8 +38,6 @@ I also welcome pull requests of all shapes and sizes. Please submit to the dev b
- [Noah Slater](http://github.com/nslater)
- [Peter Uithoven](https://github.com/peteruithoven)



### License

Copyright 2014 David Sheldrick and contributors
Expand All @@ -85,6 +53,5 @@ I also welcome pull requests of all shapes and sizes. Please submit to the dev b
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.


### | (• ◡•)| (❍ᴥ❍ʋ)
Loading

0 comments on commit f4c6832

Please sign in to comment.