Commit Graph

29 Commits

Author SHA1 Message Date
Casey Rodarmor
57e482f4b3
Record demo for readme
Uses a crate in `bin/demo` to output a demo script of commands, with a
per-character and per-line delay, and a dummy prompt. Capture output
and render to a gif.

type: documentation
2020-04-07 19:01:38 -07:00
Casey Rodarmor
8c30205b02
Add shell completion scripts
Shell completion scripts can be generated for `bash`, `elvish`, `fish`,
`powershell`, and `zsh` with the `completions` subcommand:

    $ imdl completions --shell zsh > imdl.zsh

The same scripts are available in the `completions` directory. Please
refer to your shell's documentation for more information on how to
install and use completion scripts.

type: added
2020-04-07 19:01:37 -07:00
Casey Rodarmor
6996d1a3ea
List supported OSs in readme
type: documentation
2020-04-07 19:01:33 -07:00
Casey Rodarmor
4f7eead16a
Link to blog post in readme
type: documentation
2020-04-07 19:01:33 -07:00
Casey Rodarmor
89e97144e9
Improve readme intro
type: documentation
2020-04-07 19:01:31 -07:00
Casey Rodarmor
e91b419af5
Improve book
- Write introduction
- Move large readme sections into book
- Rename docs to www

type: documentation
2020-04-07 19:01:30 -07:00
Casey Rodarmor
901fa150ff
Indicate BEP 9 support in readme
type: documentation
2020-04-07 19:01:28 -07:00
Casey Rodarmor
0b486cc681
Update BEP list in readme with new issue links
type: documentation
2020-04-07 19:01:27 -07:00
Casey Rodarmor
f8e3fd594b
Add explanation paragraph to readme
type: documentation
2020-04-07 19:01:26 -07:00
Casey Rodarmor
fdb18bb8d8
Update discord invite link
type: documentation
2020-04-07 19:01:06 -07:00
Casey Rodarmor
55f2fcc738
Add discord badge to readme
type: documentation
2020-04-07 19:01:06 -07:00
Casey Rodarmor
355f76b86d
Update badges
- Add crates.io badge
- Make build badge link to actions page

type: documentation
2020-04-07 19:01:06 -07:00
Casey Rodarmor
b0962722c7
Add Github Actions build badge to readme
Also change the name of the main workflow from Main to Build, since I'd
like the badge to say "Build | Passing".

type: documentation
2020-04-07 19:01:06 -07:00
Casey Rodarmor
165a7ea444
Support adding DHT bootstrap nodes to created torrents
The --dht-node flag can be used to add DHT bootstrap nodes to new torrents.

This is the only piece of metainfo-related functionality in BEP 5, so we can mark BEP
5 as implemented.

type: added
2020-04-07 19:01:05 -07:00
Casey Rodarmor
99a069a021
Add imdl torrent show
The `imdl torrent show` command displays information about on-disk
torrent files. The formatting of the command's output is copied from
torf, an excellent command-line torrent creator, editor, and viewer.

type: added
2020-04-07 19:01:02 -07:00
Casey Rodarmor
85f02d9f29
Add pyrocore to prior art section of readme
Pyrocore is an extensive suite of both general bittorrent and rtorrent
specific tools.

type: documentation
2020-04-07 19:01:02 -07:00
Casey Rodarmor
e2c1f29160
Center symbols in BEP support table key in readme
type: documentation
2020-04-07 19:01:01 -07:00
Casey Rodarmor
48ca86c67c
Add Alternatives & Prior Art section to readme
type: documentation
2020-04-07 19:01:00 -07:00
Casey Rodarmor
ef5be39f9b
Update install instructions to new domain
Install script location is now https://imdl.io/install.sh

type: distribution
2020-04-07 19:01:00 -07:00
Casey Rodarmor
e2cf93efb0
Add install script and installation section to readme
type: distribution
2020-04-07 19:00:59 -07:00
Casey Rodarmor
495316e821
Add table of references to readme
type: documentation
2020-04-07 19:00:59 -07:00
Casey Rodarmor
a8446c82db
Test UDP tracker URLs parse
Also change UDP tracker protocol extensions from unsupported to N/A.

type: testing
2020-04-07 19:00:59 -07:00
Casey Rodarmor
0560181a09
Remove redundant information from the readme
The removed information was added to help messages, so it was redundant.

type: documentation
2020-04-07 19:00:59 -07:00
Casey Rodarmor
1a20f0d0b3
Link to tracking issues from BEP support table
type: documentation
2020-04-07 19:00:58 -07:00
Casey Rodarmor
801a519265
BEP 3 is supported
type: documentation
2020-04-07 19:00:51 -07:00
Casey Rodarmor
1f5b829742
Add table of contents to readme
type: documentation
2020-04-07 19:00:48 -07:00
Casey Rodarmor
66d44155f0
Add BEP support table to readme
Also adds `bin/bin/generate-bep-table.rs`, which generates and updates
the table from a collection of BEPs.

type: documentation
2020-04-07 19:00:48 -07:00
Casey Rodarmor
d1f8f24d8e
Add colored output
Colored output can be controlled on the command line with
`--use-color auto|always|never`. The default is `auto`, which enables
color if `imdl` detects that it is printing to a terminal.

Color can be disabled entirely by setting the `NO_COLOR` environment
variable.

type: added
2020-04-07 19:00:47 -07:00
Casey Rodarmor
98335f435d
Initial commit
type: added
2020-04-07 18:55:30 -07:00