Skip to content

Commit ddd9698

Browse files
committed
Update README
1 parent 06beacd commit ddd9698

File tree

3 files changed

+52
-5
lines changed

3 files changed

+52
-5
lines changed

README.md

Lines changed: 52 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,59 @@
1-
# write-music
1+
<div align="center">
2+
<a href="https://herculino.com/write-music" target="_blank">
3+
<img alt="Write Music" title="Write Music" src="./assets/write-music.png" width="500" />
4+
</a>
5+
</div>
26

3-
See the rhythm of your text right on your browser.
7+
<h1 align="center">Write Music</h1>
8+
<p align="center">See the rhythm of your text right on your browser.</p>
49

5-
![alt text](https://i.imgur.com/VGzMFB5.png "Gary Provost's This Sentence Has 5 Words quote")
10+
<div align="center">
11+
<a href="https://github.com/eitchtee/write-music/blob/master/LICENSE" target="_blank"><img alt="GitHub" src="https://img.shields.io/github/license/eitchtee/write-music?style=for-the-badge"></a>
12+
<a href="https://herculino.com/write-music" target="_blank"><img alt="Website" src="https://img.shields.io/website?style=for-the-badge&url=https%3A%2F%2Fherculino.com/write-music"></a>
13+
</div>
14+
15+
<br/>
616

717
---
818

9-
Loosely based on a writing tip by [Gary Provost](https://www.garyprovost.com/). Heavily dependent on [lonekorean's](https://github.com/lonekorean) plugin: [highlight-within-textarea](https://github.com/lonekorean/highlight-within-textarea).
19+
<p align="center">
20+
<a href="#whats-this">❓ What's this?</a> •
21+
<a href="#tech-stack">🛠️ Tech Stack</a> •
22+
<a href="#development">✏️ Development</a>
23+
</p>
24+
25+
## What's This?
26+
Write Music is a simple browser tool for seeing and hearing your writing's reading rhythm, based on a [Gary Provost's](https://www.garyprovost.com/) writing tip which seems to be used by [Amazon's Marketing Team](https://medium.com/better-marketing/amazon-accidentally-sent-out-their-email-template-33e6ecbc0875).
27+
28+
**Everything is done in-browser and no data is stored or sent to a server.**
29+
30+
## Tech Stack
31+
32+
##### **Website**
33+
34+
- **Pure HTML and CSS**
35+
- **[jQUery](https://jquery.com/)**
36+
- **[highlight-within-textarea](https://github.com/lonekorean/highlight-within-textarea)**
37+
38+
##### **Hosting**
39+
40+
- **[Github Pages](https://pages.github.com/)**
41+
42+
##### **Tools**
43+
44+
- _Editor_: **[WebStorm](https://www.jetbrains.com/webstorm/)**
45+
46+
47+
## Development
48+
49+
There are no special requirements.
50+
51+
Clone this repo and edit `index.html` and `script.js`
52+
53+
---
1054

55+
<div align="center">
56+
<img alt="Gary Provost's This Sentence Has 5 Words quote" title="Write Music" src="./assets/gary-tip.png">
57+
</div>
1158

12-
[Click here](https://eitchtee.github.io/write-music/) and have a go, but remember: `Don't just write words. Write music`.
59+
<div align="center"><code align="center">Write Music</code></div>

assets/gary-tip.png

23.4 KB
Loading

assets/write-music.png

575 KB
Loading

0 commit comments

Comments
 (0)