docs: update changelog and readme for cd-browser v0.1.1
This commit is contained in:
47
README.md
47
README.md
@@ -1,24 +1,49 @@
|
||||
# cd-browser
|
||||
|
||||
`cd-browser` is a terminal-native directory navigator for fast filesystem browsing from the command line.
|
||||
**Stop typing paths. Browse them.**
|
||||
|
||||
It provides an interactive interface for exploring directories with the keyboard and returns the selected path at the end of the session so shell wrappers can change the current shell directory.
|
||||
`cd-browser` is a fast keyboard-driven directory navigator for the terminal.
|
||||
It lets you explore directory trees visually and jump to any folder instantly.
|
||||
|
||||

|
||||
|
||||
## Why cd-browser?
|
||||
|
||||
Working in the terminal often means:
|
||||
|
||||
- typing long directory paths
|
||||
- navigating deep folder trees
|
||||
- repeating `cd ..` multiple times
|
||||
|
||||
`cd-browser` provides an **interactive terminal UI** that allows you to browse directories with the keyboard and return the selected path directly to your shell.
|
||||
|
||||
## Features
|
||||
|
||||
- 🚀 Fast visual navigation of directory trees
|
||||
- ⌨️ Fully keyboard-driven workflow
|
||||
- 🌲 Expand and collapse directories
|
||||
- 📜 Navigation history inside the session
|
||||
- 🖥 Native terminal interface
|
||||
- 🔁 Works with Bash, Zsh and other shells
|
||||
- ⚡ Returns the selected path to the shell
|
||||
|
||||
## Quick Demo
|
||||
|
||||
Run:
|
||||
|
||||
```bash
|
||||
cd_
|
||||
```
|
||||
|
||||
Browse directories using the arrow keys and press **Enter** to jump directly to the selected folder.
|
||||
|
||||
## Documentation
|
||||
|
||||
See the documentation index:
|
||||
|
||||
```
|
||||
docs/index.md
|
||||
|
||||
## Features
|
||||
|
||||
- Interactive terminal directory browser
|
||||
- Keyboard-driven navigation
|
||||
- Parent directory entry via `..`
|
||||
- Expand and collapse directory trees
|
||||
- Session navigation history support in the application state
|
||||
- Installable CLI command: `cd_browser`
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
|
||||
Reference in New Issue
Block a user