Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
ckardaris committed Feb 10, 2019
1 parent 2238b47 commit f7c6f4f
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
# tormix
<a href="https://imgur.com/gallery/zrP4rGm" target="_blank"><img src="https://i.imgur.com/3jCzXVt.png" alt="img" height="200px"/></a>

Based on the <a href="https://github.com/dylanaraps/torque">original project</a> from <a href="https://github.com/dylanaraps">dylanaraps</a><br>
I decided to change the name (to not conflict with other existing programs) and add many more features

A simple TUI client for the `transmission-cli`.

- Written in `bash`.

Based on the <a href="https://github.com/dylanaraps/torque">original project</a> from <a href="https://github.com/dylanaraps">dylanaraps</a><br>
I decided to change the name (to not conflict with other existing programs) and add many more features.

## Dependencies

- `bash`
- `transmission-cli`

## Installation
This is a `bash` script, so it does not require an installation.<br><br>
Nevertheless, if you want to properly configure the `.config/tormix` directory for color support<br>
and place the script and its man page in the proper directories of `/usr`, you can run<br><br>
`./install` (it requires sudo access)<br><br>
In any case, you can always place the script where you like manually.

## Running

1. Start `transmission-daemon`.
Expand Down

0 comments on commit f7c6f4f

Please sign in to comment.