Skip to content

Commit

Permalink
[REF] Better README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KeyWeeUsr committed Aug 17, 2024
1 parent 2d02b0e commit 82f8622
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[![MELPA][melpa-badge]][melpa-package]
[![MELPA Stable][melpa-stable-badge]][melpa-stable-package]
[![Buy me a coffee][bmc-badge]][bmc-link]
[![Liberapay][lp-badge]][lp-link]
[![PayPal][ppl-badge]][ppl-link]

# typewriter-roll-mode

Expand All @@ -13,7 +16,25 @@ losing such a thought in the process.
Install it from [Melpa](https://melpa.org/#/getting-started) or clone and
install manually, then simply `M-x typewriter-roll-mode`.

### Enable for file extensions

It might be useful to auto-enable the mode for certain files or patterns. One
of such methods is updating `auto-mode-alist`:

```emacs-lisp
(add-to-list 'auto-mode-alist
'("\\.my-quick-note.txt\\'" . typewriter-roll-mode))
```

For every file with `.my-quick-note.txt` extension.

[melpa-badge]: http://melpa.org/packages/typewriter-roll-mode-badge.svg
[melpa-package]: http://melpa.org/#/typewriter-roll-mode
[melpa-stable-badge]: http://stable.melpa.org/packages/typewriter-roll-mode-badge.svg
[melpa-stable-package]: http://stable.melpa.org/#/typewriter-roll-mode
[bmc-badge]: https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee
[bmc-link]: https://www.buymeacoffee.com/peterbadida
[ppl-badge]: https://img.shields.io/badge/-paypal-grey?logo=paypal
[ppl-link]: https://paypal.me/peterbadida
[lp-badge]: https://img.shields.io/badge/-liberapay-grey?logo=liberapay
[lp-link]: https://liberapay.com/keyweeusr

0 comments on commit 82f8622

Please sign in to comment.