Skip to content

Commit 5f07ada

Browse files
committed
update docs
1 parent 210adc1 commit 5f07ada

File tree

5 files changed

+25
-25
lines changed

5 files changed

+25
-25
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jobs:
3838

3939
# NEW STEP: Create the redirect page
4040
- name: Create redirect page
41-
run: echo '<meta http-equiv="refresh" content="0; url=rjot">' > target/doc/index.html
41+
run: echo '<meta http-equiv="refresh" content="0; url=lstr">' > target/doc/index.html
4242

4343
- name: Setup Pages
4444
uses: actions/configure-pages@v5

CHANGELOG.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,30 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [0.x.y] - 2025-06-14
8+
## [0.2.0] - 2025-06-17
99

1010
### Added
1111

12-
- **Shell integration:** In interactive mode, pressing `Ctrl+s` now quits the application and prints the selected path to standard output, allowing `lstr` to be used as a file picker for other shell commands.
13-
- **Git integration:** To display file statuses, use the new `-G, --git-status` flag.
14-
- Shows status indicators for modified (`M`), new (`A`), untracked (`?`), and more.
15-
- Available in both classic `view` and `interactive` modes.
16-
- Added an optional `-s, --size` flag to display file sizes in both classic and interactive modes.
17-
- Added an optional `-p, --permissions` flag to display file permissions in both classic and interactive modes (**Unix-like systems only**).
18-
- **Interactive Mode**: A new `interactive` subcommand that launches a terminal-based UI.
19-
- Keyboard-driven navigation of the file tree (`Up`/`Down`, `j`/`k`).
20-
- Directory expansion and collapsing with the `Enter` key.
21-
- Ability to open selected files in the default editor (`$EDITOR`) by pressing `Enter`.
22-
- Shell integration support via `Ctrl+s` to quit and print the selected path.
23-
- Support for `-g` (`--gitignore`), `-a` (`--all`), and `--icons` flags in interactive mode.
24-
- A new `--expand-level` flag to set the initial expansion depth in interactive mode.
25-
- Support [Nerd Fonts](https://www.nerdfonts.com/) to display file-specific icons via a new `--icons` argument.
26-
- Directory names are now displayed in bold for better visibility.
12+
- **Interactive Mode:** A new `interactive` subcommand that launches a terminal-based UI.
13+
- Keyboard-driven navigation (`Up`/`Down`, `j`/`k`).
14+
- Directory expansion and collapsing with `Enter`.
15+
- Ability to open selected files in the default editor (`$EDITOR`).
16+
- **Git Integration:** A new `-G, --git-status` flag displays file statuses (`M`, `A`, `?`, etc.) in both classic and interactive modes.
17+
- **Shell Integration:** In interactive mode, pressing `Ctrl+s` now quits and prints the selected path to `stdout`, allowing `lstr` to be used as a file picker for other shell commands.
18+
- **Rich Information Display:**
19+
- Added `--icons` flag to display file-specific icons (requires a Nerd Font).
20+
- Added `-s, --size` flag to display file sizes.
21+
- Added `-p, --permissions` flag to display file permissions (Unix-like systems only).
22+
23+
### Fixed
24+
25+
- Resolved an issue where the `--gitignore` (`-g`) flag would fail to ignore files in certain environments.
26+
- Fixed a critical bug where the interactive TUI would hang and produce garbled output when piped to another command.
2727

2828
## [0.1.1] - 2025-06-06
2929

3030
### Added
31+
3132
- Initial release of `lstr`.
3233
- Core recursive directory tree walking and printing functionality.
3334
- Colorized output for directories, configurable with the `--color` flag (`always`, `auto`, `never`).

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "lstr"
3-
version = "0.1.2"
3+
version = "0.2.0"
44
authors = ["Brandon Greenwell <greenwell.brandon@gmail.com>"]
55
edition = "2021"
66
description = "A blazingly fast, minimalist directory tree viewer, written in Rust."

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,11 @@ Launch the TUI with `lstr interactive [OPTIONS] [PATH]`.
7474

7575
| Key(s) | Action |
7676
| :------ | :------------------------------------------------------------------------------------------------------------------------------------------ |
77-
| `` / `k` | Move selection up. |
78-
| `` / `j` | Move selection down. |
79-
| `Enter` | **Context-aware action:**\<br/\>- If on a file: Open it in the default editor (`$EDITOR`).\<br/\>- If on a directory: Toggle expand/collapse. |
80-
| `q` / `Esc` | Quit the application normally. |
81-
| `Ctrl`+`s` | **Shell integration:** Quits and prints the selected path to stdout. |
82-
77+
| `` / `k` | Move selection up. |
78+
| `` / `j` | Move selection down. |
79+
| `Enter` | **Context-aware action:**<br>- If on a file: Open it in the default editor (`$EDITOR`).<br>- If on a directory: Toggle expand/collapse. |
80+
| `q` / `Esc` | Quit the application normally. |
81+
| `Ctrl`+`s` | **Shell integration:** Quits and prints the selected path to stdout. |
8382

8483
## Examples
8584

0 commit comments

Comments
 (0)