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.

Sign up for GitHub

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

Jump to bottom

Auto-update README.md about CLI usage and commands #111

Merged
merged 4 commits into from
Mar 19, 2021
Merged

Auto-update README.md about CLI usage and commands #111

merged 4 commits into from
Mar 19, 2021

Conversation

cham11ng
Copy link
Contributor

Implement auto-update README.md about CLI usage and commands using oclif-dev library.

More detail:

➜  sync-db auto-update-doc ✓ yarn oclif-dev readme --help
yarn run v1.22.10
$ /Users/cham11ng/Source/sync-db/node_modules/.bin/oclif-dev readme --help
adds commands to README.md in current directory

USAGE
  $ oclif-dev readme

OPTIONS
  --dir=dir  (required) [default: docs] output directory for multi docs
  --multi    create a different markdown page for each topic

DESCRIPTION
  The readme must have any of the following tags inside of it for it to be replaced or else it will do nothing:
  # Usage
  <!-- usage -->
  # Commands
  <!-- commands -->

  Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.

@cham11ng cham11ng self-assigned this Mar 19, 2021
@cham11ng cham11ng added the documentation Improvements or additions to documentation label Mar 19, 2021
@cham11ng cham11ng changed the title @Auto-update README.md about CLI usage and commands Auto-update README.md about CLI usage and commands Mar 19, 2021
@cham11ng cham11ng requested a review from SafalPandey March 19, 2021 12:02
mesaugat
mesaugat reviewed Mar 19, 2021
View reviewed changes
release.sh Outdated Show resolved Hide resolved
@mesaugat mesaugat merged commit 8a30dcb into master Mar 19, 2021
@mesaugat mesaugat deleted the auto-update-doc branch March 19, 2021 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@samirsilwal samirsilwal samirsilwal approved these changes

@mesaugat mesaugat mesaugat approved these changes

@kabirbaidhya kabirbaidhya Awaiting requested review from kabirbaidhya

@SafalPandey SafalPandey Awaiting requested review from SafalPandey

Assignees

@cham11ng cham11ng

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@cham11ng @mesaugat @samirsilwal