diff --git a/Cargo.toml b/Cargo.toml index c9795f3..ca19053 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,11 +3,14 @@ name = "xplr" version = "0.5.0" # Update config.yml, config.rs and default.nix authors = ["Arijit Basu "] edition = "2018" -description = "A hackable, minimal, fast TUI file explorer, stealing ideas from nnn and fzf" +description = "A hackable, minimal, fast TUI file explorer" license = "MIT" readme = "README.md" repository = "https://github.com/sayanarijit/xplr" homepage = "https://github.com/sayanarijit/xplr" +documentation = "https://github.com/sayanarijit/xplr/Wiki" +keywords = ["terminal", "file", "explorer", "manager", "tui"] +categories = ["command-line-interface", "command-line-utilities"] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/README.md b/README.md index 0c689c6..4b43bae 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,65 @@

xplr

-A hackable, minimal, fast TUI file explorer, stealing ideas from nnn and fzf. +A hackable, minimal, fast TUI file explorer

- - - - - - - - -

- - - +

-

-[Quickstart] -[Features] -[Plugins] -[Documentation] -[Upgrade Guide] -[TODO] -

- -
- Though [xplr](https://github.com/sayanarijit/xplr) strives to be fast and minimalist, its speciality is its hackability. Once you read the [documentation](https://github.com/sayanarijit/xplr/wiki), you should be able to configure the key bindings, different run modes, and also the way it looks by modifying one single configuration file. + +- ### [Quickstart](https://github.com/sayanarijit/xplr/wiki/Quickstart) + +- ### [Features](https://github.com/sayanarijit/xplr/wiki/Features) + +- ### [Plugins](https://github.com/sayanarijit/xplr/wiki/Plugins) + +- ### [Hacks](https://github.com/sayanarijit/xplr/wiki/Hacks) + +- ### [Themes](https://github.com/sayanarijit/xplr/wiki/Themes) + +- ### [TODO](https://github.com/sayanarijit/xplr/wiki/TODO) + +- ### [Upgrade Guide](https://github.com/sayanarijit/xplr/wiki/Upgrade-Guide) + +- ### [Alternatives](https://github.com/sayanarijit/xplr/wiki/Alternatives) + + +## Demo +

- - + + + + + + + + + + + + + +

-If you come up with something cool, or if you feel it's lacking somewhere in portability, flexibility or performance, don't hesitate to -[start a conversation](https://github.com/sayanarijit/xplr/discussions/2). -

Backers

+## Backers