Skip to content

Docs: Cargo Installation Instructions point at outdated version #163

@fryeb

Description

@fryeb

What were you searching in the docs?

Looking for install instructions in README.md. The docs present both cargo install and brew install as equivalent options, but on installation I found that cargo install fetches an out of date version (v0.4.1 vs v0.13.0 for brew install).

Is this related to an existing documentation section?

https://github.com/clowdhaus/eksup/blob/main/README.md#installation

How can we improve?

Either the two instructions should be equivalent, or there should be documentation indicating that they are not.

Got a suggestion in mind?

There are 2 potential resolutions to this problem. One option would be to publish releases on crates.io at the same time as brew, the other would be to remove the cargo documentation (or specify in the README that cargo installs an out of date version).

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationDocumentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions