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

Update documentation to reflect more the current API #62

Open
7 tasks done
Barbapapazes opened this issue Sep 5, 2023 · 3 comments
Open
7 tasks done

Update documentation to reflect more the current API #62

Barbapapazes opened this issue Sep 5, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Barbapapazes
Copy link
Member

Barbapapazes commented Sep 5, 2023

related to #46

Hello,

This issue will be used to track documentation update that we need to provide.

PR welcomes to help! (and do not hesitate to comment if you have more idea)

Tasks

Preview Give feedback
@Barbapapazes Barbapapazes added the documentation Improvements or additions to documentation label Sep 5, 2023
@Barbapapazes Barbapapazes self-assigned this Sep 5, 2023
@Barbapapazes Barbapapazes changed the title Update documentation Update documentation to reflect more the current API Sep 5, 2023
@nozomuikuta
Copy link
Member

@Barbapapazes

It would be worth adding "how to make the CLI available as 'binary'".
I mean like, how to set up the CLI as bin?

// in development
node mycommand arg

// when published
mycli mycommand arg

@Barbapapazes
Copy link
Member Author

@Barbapapazes

It would be worth adding "how to make the CLI available as 'binary'".
I mean like, how to set up the CLI as bin?

// in development
node mycommand arg

// when published
mycli mycommand arg

Thanks for the feedback, that's a great idea!

@Barbapapazes
Copy link
Member Author

@pi0, do you think we could add a section they use citty to the docs to highlight projects (like nuxt-ng) to help user to create their own?

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

No branches or pull requests

2 participants