Skip to content

Commit

Permalink
Remove redundant information from the readme
Browse files Browse the repository at this point in the history
The removed information was added to help messages, so it was redundant.

type: documentation
  • Loading branch information
casey committed Apr 8, 2020
1 parent 1a20f0d commit 0560181
Showing 1 changed file with 3 additions and 22 deletions.
25 changes: 3 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
- [General](#general)
- [Semantic Versioning](#semantic-versioning)
- [Unstable Features](#unstable-features)
- [Colored Output](#colored-output)
- [Bittorrent](#bittorrent)
- [BEP Support](#bep-support)

Expand All @@ -26,27 +25,9 @@ In particular:
### Unstable Features

To avoid premature stabilization and excessive version churn, unstable features
are unavailable unless the `--unstable` / `-u` flag is passed. Unstable
features may be changed or removed at any time.

```
$ imdl torrent stats --input tmp
error: Feature `torrent stats subcommand` cannot be used without passing the `--unstable` flag
$ imdl --unstable torrent stats tmp
Torrents processed: 0
Read failed: 0
Decode failed: 0
```

### Colored Output

Intermodal features colored help, error, and informational output. Colored
output is disabled if Intermodal detects that it is not printing to a TTY.

To disable colored output, set the `NO_COLOR` environment variable to any
value or pass `--use-color never` on the command line.

To force colored output, pass `--use-color always` on the command line.
are unavailable unless the `--unstable` / `-u` flag is passed, for example
`imdl --unstable torrent create .`. Unstable features may be changed or removed
at any time.

## Bittorrent

Expand Down

0 comments on commit 0560181

Please sign in to comment.