feat: rewrite README in English, update plugin info, and localize scripts

- Rewrite README.md in English with detailed features, installation,
  usage, and configuration instructions
- Update plugin name and repository references to "tmux-remind"
- Change script comments and popup titles from Italian to English
- Standardize less status line in show_calendar.sh to English
This commit is contained in:
2025-12-24 12:53:37 +01:00
parent 13a22c61fd
commit 9d33272a55
3 changed files with 51 additions and 26 deletions

View File

@@ -1,38 +1,64 @@
# Plugin Name
# tmux-remind
Descrizione del plugin.
A tmux plugin that integrates with [remind](https://dianne.skoll.ca/projects/remind/) to display reminders and calendar views in tmux popups.
## Installazione
## Features
### Con TPM
- **Quick Reminders View**: Display today's reminders in a centered popup (60% width/height)
- **Calendar View**: Show a 2-week calendar overview in a full-screen popup (99% width/height)
- Uses `less` for scrollable output with line position indicator
Aggiungi al tuo `~/.tmux.conf`:
## Requirements
- [remind](https://dianne.skoll.ca/projects/remind/) - A sophisticated calendar and alarm program
- tmux 3.2+ (for `display-popup` support)
## Installation
### With TPM (Tmux Plugin Manager)
Add to your `~/.tmux.conf`:
```bash
set -g @plugin 'tuo-username/plugin-name'
set -g @plugin 'your-username/tmux-remind'
```
Ricarica tmux e premi `prefix + I` per installare.
Reload tmux and press `prefix + I` to install.
### Manuale
### Manual Installation
```bash
git clone https://github.com/tuo-username/plugin-name ~/.tmux/plugins/plugin-name
git clone https://github.com/your-username/tmux-remind ~/.tmux/plugins/tmux-remind
```
Aggiungi a `~/.tmux.conf`:
Add to your `~/.tmux.conf`:
```bash
run-shell ~/.tmux/plugins/plugin-name/plugin-name.tmux
run-shell ~/.tmux/plugins/tmux-remind/tmux-remind.tmux
```
## Configurazione
## Usage
```bash
# Opzione esempio (default: "value")
set -g @plugin_option "custom_value"
```
The plugin provides two keybindings:
## Licenza
| Keybinding | Action |
|------------|--------|
| `prefix + r` | Show today's reminders in a popup |
| `prefix + c` | Show 2-week calendar in a popup |
### Navigation
Both views use `less` for navigation:
- `j` / `k` or arrow keys to scroll
- `q` to close the popup
- `/` to search
- `g` to go to top, `G` to go to bottom
## Configuration
The plugin uses your default `remind` configuration. Make sure you have your `.reminders` file set up in your home directory or configure remind accordingly.
## License
MIT