Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
babarot committed Feb 4, 2020
1 parent 52683cd commit 63cfa55
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
<p align="center">
<img src="./docs/screenshot.png" width="500" alt="gomi">
</p>

[![](http://img.shields.io/github/release/b4b4r07/gomi.svg?style=flat-square)][release] [![](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)][license]
[![](http://img.shields.io/github/release/b4b4r07/gomi.svg?style=flat)][release] [![](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)][license] [![](https://github.com/b4b4r07/gomi/workflows/release/badge.svg)](https://github.com/b4b4r07/gomi/releases)

`gomi` is a simple trash tool that works on CLI, written in Go

The concept of the trashcan does not exist in Command-line interface ([CLI](http://en.wikipedia.org/wiki/Command-line_interface)). If you have deleted an important file by mistake with the `rm` command, it would be difficult to restore. Then, it's this `gomi`. Unlike `rm` command, it is possible to easily restore deleted files because `gomi` have the trashcan for the CLI. It is also possible to work with trashcan for Graphical user interface ([GUI](http://en.wikipedia.org/wiki/Graphical_user_interface)).
The concept of the trashcan does not exist in Command-line interface ([CLI](http://en.wikipedia.org/wiki/Command-line_interface)). If you have deleted an important file by mistake with the `rm` command, it would be difficult to restore. Then, it's this `gomi`. Unlike `rm` command, it is possible to easily restore deleted files because `gomi` have the trashcan for the CLI.

## Features

- Like a `rm` command but not unlink (delete) in fact (just move to another place)
- Easy to restore, super intuitive
- Compatible with `rm` command, e.g. `-r`, `-f` options
- Nice UI, awesome CLI UX
- Easy to debug with setting `GOMI_LOG=[trace|debug|info|warn|error]`
- Easy to see what gomi does with setting `GOMI_LOG=[trace|debug|info|warn|error]`

## Installation

Download the binary from [GitHub Releases][release] and drop it in your `$PATH`.

- [Darwin / Mac](https://github.com/b4b4r07/gomi/releases/latest)
- [Linux](https://github.com/b4b4r07/gomi/releases/latest)
- [Darwin / Mac][release]
- [Linux][release]

## Versus

Expand All @@ -30,7 +29,7 @@ Download the binary from [GitHub Releases][release] and drop it in your `$PATH`.

## License

[MIT](license) (c) BABAROT (a.k.a. [b4b4r07](https://tellme.tokyo))
[MIT][license]

[release]: https://github.com/b4b4r07/gomi/releases
[release]: https://github.com/b4b4r07/gomi/releases/latest
[license]: https://b4b4r07.mit-license.org

0 comments on commit 63cfa55

Please sign in to comment.