> [!IMPORTANT]  
> Work in progress

<h1 align="center">dance</h1>
  
<p align="center">
    <img src="https://img.shields.io/badge/license-MIT-green?style=flat-square" alt="MIT License" />
  <img src="https://img.shields.io/github/last-commit/simon-danielsson/dance/main?style=flat-square&color=blue" alt="Last commit" />
</p>
  
<p align="center">
  <a href="#info">Info</a> •
  <a href="#install">Install</a> •
  <a href="#usage">Usage</a> •
  <a href="#license">License</a>
</p>  
  
---
<div id="info"></div>

## Info
  
### Features
- Add your favorite directories and dance between them.
- Add your favorite files and dance into them with your favorite editor.
  
### Requirements
- Unix system
  
<div id="install"></div>
  
## Install
  
### Binary
  
``` terminal
cargo install dnc
```
  
### Shell integration
  
#### fish
    
``` fish
function dnc
    set dir (~/.cargo/bin/dnc | string match -r '/.*')
    cd $dir
end
```
  
---
<div id="usage"></div>
  
## Usage
  
``` terminal
Usage: dnc [FLAG(S) | COMMAND]

When opening a location:
    * Directory
        CD into it through terminal.
    * Text files
        Open in editor (see "editor" command)
    * Other/unknown files
        Open through "open" on MacOS or "xdg-open" on Linux.

----------------------------

Flags

-l                   Disable "last accessed" behaviour.
-s                   Hide shortcut hints.
-h, --help           Displays this help message. When the help flag
                     is added, it will override all other flags or arguments.

Commands

editor <cmd>         Sets editor command for opening files (default: "nvim").

add [path]           Add a file or directory to the dance menu.
                     Defaults to current directory if no argument was added.
                     You can add as many favorites as you can handle.

reset                Resets dance to its default state, removing all
                     perpetually stored data.
```
  
---
<div id="license"></div>
  
## License
  
This project is licensed under the [MIT License](https://github.com/simon-danielsson/dance/blob/main/LICENSE).  
 
