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

re-work readme, add examples for william #9

Merged
merged 1 commit into from Dec 22, 2020
Merged

Conversation

ryankurte
Copy link
Collaborator

@ryankurte ryankurte commented Dec 17, 2020

how's this @Firstyear? (thanks for the feedback!)

Copy link

@Firstyear Firstyear left a comment

Choose a reason for hiding this comment

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

Generally much better! Thank you!

First you'll need to install `cargo-binstall` either via `cargo install cargo-binstall` (and it'll have to compile, sorry...), or by grabbing a pre-compiled version from the [releases](https://github.com/ryankurte/cargo-binstall/releases) page and putting that somewhere on your path. It's like there's a problem we're trying to solve?

Once a project supports `binstall` you can then install binaries via `cargo binstall NAME` where `NAME` is the name of the crate. This will then fetch the metadata for the provided crate, lookup the associated binary file, and download this onto your system.
By default the latest version is installed, which can be overridden using the `--version` argument, and packages are installed to `$HOME/.cargo/bin` as is consistent with `cargo install`, which can be overridden via the `--install-path` argument. As always `--help` will show available options.

Choose a reason for hiding this comment

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

Could be worth mentioning how you track/manage multi-versions, updates etc.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

hmm i'm not sure how to describe this rn :-/

Choose a reason for hiding this comment

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

So .... you do allow mulitple versions to be installed? Or not?

Copy link
Collaborator Author

@ryankurte ryankurte Dec 20, 2020

Choose a reason for hiding this comment

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

it'll clobber anything with the same name atm, extract is just a blind .tgz into output dir...

could specify binary names in the metadata then symlink against em instead which would be dope for atomic updating (and then this would also be an in-app atomic update library lol). it'd be more configuration but, could be optional if not required... recon that's worth the effort?

Choose a reason for hiding this comment

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

Yeah, it probably is. I think homebrew does something similar. Allows fast rollbacks etc.

Something to keep an eye on is tar extraction attacks (../ or symlinks etc).

Copy link
Collaborator Author

@ryankurte ryankurte Dec 22, 2020

Choose a reason for hiding this comment

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

Something to keep an eye on is tar extraction attacks (../ or symlinks etc).

yeah the official policy on this is -yolo- at this time, mayybe a confirmation in the default case would be good to eh

@ryankurte ryankurte merged commit 0c72b89 into main Dec 22, 2020
@ryankurte ryankurte deleted the fix/readme-examples branch December 22, 2020 21:41
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.

None yet

2 participants