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

Add documentation about the password-cli executable #83

Open
7 tasks
Vlix opened this issue Oct 20, 2024 · 1 comment
Open
7 tasks

Add documentation about the password-cli executable #83

Vlix opened this issue Oct 20, 2024 · 1 comment

Comments

@Vlix
Copy link
Collaborator

Vlix commented Oct 20, 2024

We now have a working CLI (AFAWK) that can be used by anyone.

Adding this executable to hackage is not necessary as anyone can just build it, given this repo. But no one will if they don't know it exists, so we should "announce" the existence of this CLI in the password library('s documentation).

Maybe also make it prominent in the README so that it's the first thing anyone reads after "this is a package/library for handling passwords".

  • Tell users of the password package/library that there's a password-cli executable in this repo
    • password package's README
    • password introduction documentation (in every algo's module)
    • the GitHub repository's README in general
  • Fix the password-cli documentation while we're at it
    • Don't use "..." but '...' when giving console examples (any hash with $ in them will fail because of variable interpolation, e.g. bcrypt hashes)
    • Also address the above point literally in the text, as this can be an annoying "gotcha"
@cdepillabout
Copy link
Owner

cdepillabout commented Oct 22, 2024

executable to hackage is not necessary as anyone can just build it, given this repo

I'd recommend releasing it to Hackage, since Hackage is supposed to be for both end-user executables as well as libraries.

There are a few Linux distros that are able to automatically package things from Hackage, but won't (automatically) package Haskell executables that aren't uploaded to Hackage. A big benefit of uploading executables to Hackage is to make them automatically available to the users of these Linux distros.

I also agree with documenting the password-cli in the places you suggest.

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

No branches or pull requests

2 participants