Skip to content

Commit

Permalink
Add examples
Browse files Browse the repository at this point in the history
  • Loading branch information
timothebot committed Jul 25, 2024
1 parent 2f47307 commit ac9b286
Showing 1 changed file with 48 additions and 3 deletions.
51 changes: 48 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,57 @@ Lacy is a z inspired cd alternative. It aims to make navigating easier for lazy

![Example 0](docs/assets/example_0.webp)

### Navigation without full path

You don't have to type the full directory name.
Just make sure the path matches the directory name more or less.

```sh
# normal cd
$ cd /Users/timothebot/Desktop/projects/lacy/src
cd /Users/timothebot/projects/lacy/src

# with lacy
$ y / user timo desk proj lacy sr
y / user timo prj lacy sr
# or
y / usrs timbo rojt layc rc
```

### Skipping directories

Forgot the directory name? No problem. Just skip it using `-`.

```sh
y / user timo - lacy sr

# as long as some parts are still unique, it will work... and it's very fast
y / - - - lacy sr
```

### Like cd

Everything you can do with `cd`, you can do with `y`.

```sh
y /Users/timo/Projects/Lacy/src
y ~
y ..
```

### Real paths

You can also add real paths while lazy navigating.

```sh
y /Users/timo/ desk proj lacy/src
```

## Installation

```sh
# macOS or Linux
brew install lacy
```

### Zsh

Add the following to your `.zshrc` file:
Expand All @@ -24,6 +65,10 @@ Add the following to your `.zshrc` file:
eval "$(lacy init zsh)"
```

### Other shells

Feel free to contribute the init script for your shell. I'm gonna add them as soon as I can.

## Why not `z`?

`z` is a great tool, but if you are working with a lot of projects with similar paths, it can be a pain to navigate.
Expand All @@ -35,5 +80,5 @@ You can use `z` alongside lacy.
- [x] Add support for `~`
- [x] Add support for "real" paths (e.g. `/Users/timo/ desk proj lacy`)
- [x] Add ability to skip a directory
- [ ] Add tests
- [ ] Add more tests
- [ ] Add aliases

0 comments on commit ac9b286

Please sign in to comment.