Skip to content

Commit 00d3d85

Browse files
committed
docs: add first readme draft
1 parent 2b29dce commit 00d3d85

2 files changed

Lines changed: 37 additions & 1 deletion

File tree

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,37 @@
1-
work in progress
1+
<div align="center">
2+
3+
<h1>dev-cli</h1>
4+
5+
**Fuzzy multiplexer-aware project picker**
6+
7+
[![release](https://img.shields.io/github/v/release/csvenke/dev-cli)](https://github.com/csvenke/dev-cli/releases)
8+
[![build](https://img.shields.io/github/actions/workflow/status/csvenke/dev-cli/pull-request.yml)](https://github.com/csvenke/dev-cli/actions)
9+
10+
<img src="./assets/dev-cli.png"></img>
11+
12+
</div>
13+
14+
## Installation
15+
16+
Coming soon
17+
18+
## Usage
19+
20+
```bash
21+
dev
22+
```
23+
24+
### Configuration
25+
26+
```bash
27+
export DEV_PATHS="~/repos/personal ~/repos/work"
28+
export EDITOR="nvim"
29+
```
30+
31+
### Multiplexer integration
32+
33+
When running inside `tmux` or `zellij`, dev automatically renames the current window/tab to the project name
34+
35+
## License
36+
37+
MIT

assets/dev-cli.png

144 KB
Loading

0 commit comments

Comments
 (0)