asdf-alias icon indicating copy to clipboard operation
asdf-alias copied to clipboard

README is CONFUSINGME

Open gurrenPizza opened this issue 11 months ago • 1 comments

Is your feature request related to a problem? Please describe.

The README is a bit confusing on the "Use" section.

asdf alias [ | --auto | --remove]" asdf alias --auto" asdf alias [--list]"

The amount of quote marks on this line makes it difficult for me to understand where the commands end and if any of that is an argument to the previous command or if it was supposed to be a list or not.

Describe the solution you'd like

I wish you could clarify the usage of the command in a less cluttered way as its written in the README and I believe including examples of the outputs of the commands will allow someone that is discovering the project to notice at a glance if this plugin adds the functionality they need or not

Additional context

The project seems to be amazing and appears to solve the right thing I was missing in asdf. Thanks for bringing this piece of software to life =]

gurrenPizza avatar Jan 17 '25 19:01 gurrenPizza

I believe I mostly copied this from somewhere else not thinking much about it. I agree it's not in standard usage format. I'll happily accept a contribution to update it.

On a side note, if you use asdf & alias, I recommend you check out https://mise.jdx.dev/. I've moved off asdf in favour of mise for well over a year now.

andrewthauer avatar Jan 25 '25 15:01 andrewthauer