Bump version to 0.2.1
This commit is contained in:
88
README.md
88
README.md
@@ -1,3 +1,91 @@
|
||||
# rp
|
||||
|
||||
Rich print files — markdown, JSON, code, and more — beautifully in your terminal.
|
||||
|
||||
## Features
|
||||
|
||||
- **Syntax highlighting** for 500+ languages via Pygments
|
||||
- **Markdown rendering** with headings, code blocks, tables, and links
|
||||
- **JSON formatting** with syntax highlighting
|
||||
- **Pager integration** with mouse scrolling support
|
||||
- **Stdin support** for piping content
|
||||
|
||||
## Installation
|
||||
|
||||
### Install globally with uv
|
||||
|
||||
```bash
|
||||
uv tool install .
|
||||
```
|
||||
|
||||
### Run directly with uv
|
||||
|
||||
```bash
|
||||
uv run rp <file>
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic file input
|
||||
|
||||
```bash
|
||||
rp README.md
|
||||
rp config.json
|
||||
rp script.py
|
||||
```
|
||||
|
||||
### Read from stdin
|
||||
|
||||
```bash
|
||||
cat data.json | rp
|
||||
echo '{"status": "ok"}' | rp
|
||||
curl -s https://api.example.com | rp
|
||||
```
|
||||
|
||||
### Force file type
|
||||
|
||||
```bash
|
||||
rp --type python script.txt
|
||||
rp -t json data.txt
|
||||
```
|
||||
|
||||
### Pager control
|
||||
|
||||
```bash
|
||||
rp --pager README.md # Force pager
|
||||
rp --no-pager file.py # Disable pager
|
||||
```
|
||||
|
||||
The pager prefers `less -R --mouse` for mouse scrolling when available, otherwise falls back to the system pager.
|
||||
|
||||
### Show version
|
||||
|
||||
```bash
|
||||
rp --version
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
### Setup
|
||||
|
||||
```bash
|
||||
uv sync
|
||||
```
|
||||
|
||||
### Linting & Type Checking
|
||||
|
||||
```bash
|
||||
uv run ruff check src/
|
||||
uv run ruff format src/
|
||||
uv run mypy src/
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
```bash
|
||||
uv build
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
Reference in New Issue
Block a user