Skip to content

Commit

Permalink
docs(README): Add emojis
Browse files Browse the repository at this point in the history
Increase readability by adding emojis
  • Loading branch information
joshuadanpeterson committed Jul 5, 2024
1 parent 78969ed commit 259915e
Showing 1 changed file with 31 additions and 28 deletions.
59 changes: 31 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align=center>
<h1>Typewriter</h1>
<h1>Typewriter ✍️</h1>
</div>

<div align="center">
Expand Down Expand Up @@ -65,42 +65,42 @@
</div>
</br>

A Neovim plugin that emulates a typewriter, keeping the cursor centered on the screen for a focused writing experience, and provides advanced code block navigation.
A Neovim plugin that emulates a typewriter, keeping the cursor centered on the screen for a focused writing experience, and provides advanced code block navigation. 📝✨

<div align=center>
<img src='./demos/demo.gif' height=500 width=600 title='Typewriter Demo'/>
<img src='./demos/demo.gif' height=500 width=600 title='Typewriter Demo'/>
</div>

## Features
## Features

- Keeps the cursor centered on the screen while you type or navigate.
- Simple commands to enable, disable, and toggle the typewriter mode.
- Integrates with ZenMode and True Zen for a seamless distraction-free environment.
- `:TWCenter` command to center the view around the current code block or function using [Tree-sitter](https://tree-sitter.github.io/tree-sitter/).
- `:TWTop` command to move the top of the current code block to the top of the screen.
- `:TWBottom` command to move the bottom of the current code block to the bottom of the screen.
- Set `keep_cursor_position` to `true` in plugin config to keep cursor position relative to text when centering the view or using TWTop/TWBottom.
- Set `enable_notifications` to `true` in plugin config to enable or disable notifications for actions like enabling/disabling typewriter mode, and aligning code blocks.
- Enable horizontal scrolling in Typewriter mode and center the cursor by setting `enable_horizontal_scroll` to `true` in the plugin configuration.
- Keeps the cursor centered on the screen while you type or navigate. 📌
- Simple commands to enable, disable, and toggle the typewriter mode. 🔄
- Integrates with ZenMode and True Zen for a seamless distraction-free environment. 🧘
- `:TWCenter` command to center the view around the current code block or function using [Tree-sitter](https://tree-sitter.github.io/tree-sitter/). 🌳
- `:TWTop` command to move the top of the current code block to the top of the screen. ⬆️
- `:TWBottom` command to move the bottom of the current code block to the bottom of the screen. ⬇️
- Set `keep_cursor_position` to `true` in plugin config to keep cursor position relative to text when centering the view or using TWTop/TWBottom. 📌
- Set `enable_notifications` to `true` in plugin config to enable or disable notifications for actions like enabling/disabling typewriter mode, and aligning code blocks. 🔔
- Enable horizontal scrolling in Typewriter mode and center the cursor by setting `enable_horizontal_scroll` to `true` in the plugin configuration. ↔️

<div align=center>
<h3>TWCenter Demo</h3>
<img src='./demos/twcenter_demo.gif' height=500 width=700 title='TWCenter Demo'/>
<h3>TWCenter Demo 🎥</h3>
<img src='./demos/twcenter_demo.gif' height=500 width=700 title='TWCenter Demo'/>
</div>
<br></br>
<div align=center>
<h3>TWTop/TWBottom Demo</h3>
<img src='./demos/twtop_twbottom_demo.gif' height=500 width=700 title='TWTop/TWBottom Demo'/>
<h3>TWTop/TWBottom Demo 🎥</h3>
<img src='./demos/twtop_twbottom_demo.gif' height=500 width=700 title='TWTop/TWBottom Demo'/>
</div>
<br></br>
<div align=center>
<h3>Horizontal Scrolling Demo</h3>
<img src='./demos/horizontal_scrolling.gif' height=500 width=700 title='Horizontal Scrolling Demo'/>
<h3>Horizontal Scrolling Demo 🎥</h3>
<img src='./demos/horizontal_scrolling.gif' height=500 width=700 title='Horizontal Scrolling Demo'/>
</div>

## Installation
## Installation 🔧

### Dependencies
### Dependencies 📦

Typewriter requires the following dependencies:

Expand Down Expand Up @@ -172,11 +172,11 @@ These commands allow you to control the typewriter mode in Neovim and navigate c

## [ZenMode and True Zen Configuration](https://github.com/joshuadanpeterson/typewriter.nvim/wiki/Integration-Guide)

### ZenMode
### ZenMode 🧘

[ZenMode](https://github.com/folke/zen-mode.nvim) is a plugin for Neovim written by [folke](https://github.com/folke) that provides a distraction-free coding environment by opening the current buffer in a new full-screen floating window. It hides various UI elements, works well with other floating windows, and integrates with plugins like Telescope and gitsigns. Typewriter integrates with ZenMode to automatically enable typewriter mode when entering ZenMode and disable it when exiting.

### True Zen
### True Zen 🧘

[True Zen](https://github.com/pocco81/true-zen.nvim) is another plugin for Neovim written by [pocco81](https://github.com/pocco81) that offers multiple modes to unclutter your screen, including Ataraxis (a zen mode), Minimalist, Narrow, and Focus. True Zen allows you to disable UI components, narrow a text region for better focus, and customize callbacks for each mode. Typewriter integrates with True Zen, particularly the Ataraxis mode, to automatically enable typewriter mode when entering Ataraxis and disable it when exiting.

Expand All @@ -196,6 +196,7 @@ require('packer').startup(function()
enable_with_true_zen = true,
keep_cursor_position = true,
enable_notifications = true,
enable_horizontal_scroll = true,
})
end
}
Expand Down Expand Up @@ -252,6 +253,7 @@ lazy.setup({
enable_with_true_zen = true,
keep_cursor_position = true,
enable_notifications = true,
enable_horizontal_scroll = true,
})
end,
opts = {}
Expand Down Expand Up @@ -292,19 +294,20 @@ lazy.setup({
})
```

## Wiki
## Wiki 📚

- [Home: Overview](https://github.com/joshuadanpeterson/typewriter.nvim/wiki)
- [Demos](https://github.com/joshuadanpeterson/typewriter.nvim/wiki/Demos)
- [Enable Notifications](https://github.com/joshuadanpeterson/typewriter.nvim/wiki/Enable-Notifications)
- [Enabling Horizontal Scrolling](https://github.com/joshuadanpeterson/typewriter.nvim/wiki/Enabling-Horizontal-Scrolling)
- [Installation Guide](https://github.com/joshuadanpeterson/typewriter.nvim/wiki/Installation-Guide)
- [Integration Guide](https://github.com/joshuadanpeterson/typewriter.nvim/wiki/Integration-Guide)
- [Tree‐sitter Integration for :TWCenter Command](https://github.com/joshuadanpeterson/typewriter.nvim/wiki/Tree%E2%80%90sitter-Integration-for-:TWCenter-Command)
- [TW `keep_cursor_position` Feature](https://github.com/joshuadanpeterson/typewriter.nvim/wiki/TW-%60keep_cursor_position%60-Feature)
- [Typewriter.nvim API](https://github.com/joshuadanpeterson/typewriter.nvim/wiki/Typewriter.nvim-API)
- [Typewriter.nvim Commands](https://github.com/joshuadanpeterson/typewriter.nvim/wiki/Typewriter.nvim-Commands)

## Inspiration
## Inspiration 💡

This plugin was inspired by:

Expand All @@ -314,7 +317,7 @@ This plugin was inspired by:
- [Twilight](https://github.com/folke/twilight.nvim)
- [Reddit comment by geckothegeek42](https://www.reddit.com/r/neovim/comments/1dg8myh/comment/l8pwg1a/?utm_source=share&utm_medium=web3x&utm_name=web3xcss&utm_term=1&utm_content=share_button)

## Credits
## Credits 🙏

Special thanks to the following for their inspiration and ideas:

Expand All @@ -323,10 +326,10 @@ Special thanks to the following for their inspiration and ideas:
- [JotterPad Typewriter Scrolling](https://help.jotterpad.app/en/article/typewriter-scrolling-1mb7vjz/)
- [Scrivener Typewriter Scrolling](https://scrivenerclasses.com/lesson/typewriter-scrolling/)

## License
## License 📄

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Contributing
## Contributing 🤝

Feel free to open up an [issue](https://github.com/joshuadanpeterson/typewriter.nvim/issues) or a [pull request](https://github.com/joshuadanpeterson/typewriter.nvim/pulls) to contribute to the project.

0 comments on commit 259915e

Please sign in to comment.