Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added custom port entry to readme #31

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

milankragujevic
Copy link

I didn't know go-peerflix had this capability so I went to try and implement my own, then I saw it in the source. I think it should be in the readme.

I didn't know go-peerflix had this capability so I went to try and implement my own, then I saw it in the source. I think it should be in the readme.
@@ -23,6 +23,11 @@ Access the stream on [http://localhost:8080/](http://localhost:8080/)
go-peerflix [magnet url|torrent path|torrent url]
```

To use a custom port, pass the -port flag
```sh
go-peerflix -port 9000 [magent url|torrent path|torrent url]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

magent / magnet

@Sioro-Neoku
Copy link
Owner

Please fix the typo.

For a future reference, the parameters are accessible via go-peerflix -help (or just go-peerflix). So I don't believe we should document every switch in the readme, as it is explained quite neatly there:

Usage of go-peerflix:
  -player string
        Open the stream with a video player (VLC, MPV, MPlayer)
  -port int
        Port to stream the video on (default 8080)
  -seed
        Seed after finished downloading
  -tcp
        Allow connections via TCP (default true)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants