Skip to content

Commit bd6ada0

Browse files
committed
README: features, screenshots table, building instructions
1 parent aeb498d commit bd6ada0

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

README.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
# speedreader
2-
Simple html-based text quick reading tool.
2+
Simple html-based offline quick reading tool.
3+
## features
4+
* Chose light or dark theme
5+
* Load your `.txt` file
6+
* Play, pause, rewind 10 words back or replay the whole document
7+
* Enable pauses on punctuation symbols
8+
* Track your position in a document with a progress bar
9+
* Have a per-document summary as you hit the end.
310

4-
<div style="display: flex; justify-content: space-between;">
11+
## screenshots
12+
<table align='center'>
13+
<t0>
14+
<td><img src="assets/im1.png" height: auto></td>
15+
<td><img src="assets/im2.png" height: auto></td>
16+
<td><img src="assets/im3.png" height: auto></td>
17+
</tr>
18+
</table>
519

6-
<div style="margin: 5px;">
7-
<img src="assets/im1.png" alt="Screenshot 1" style="max-width: 30%; height: auto;">
8-
</div>
9-
10-
<div style="margin: 5px;">
11-
<img src="assets/im2.png" alt="Screenshot 2" style="max-width: 30%; height: auto;">
12-
</div>
13-
14-
<div style="margin: 5px;">
15-
<img src="assets/im3.png" alt="Screenshot 3" style="max-width: 30%; height: auto;">
16-
</div>
17-
18-
</div>
19-
20-
Works entirely in browser and 100% offline.
20+
## building
21+
```sh
22+
./build.js
23+
```
24+
`speedreader.html` file will be created in `dist/` directory.

0 commit comments

Comments
 (0)