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

Docs: CLI documentation #210

Merged
merged 2 commits into from
Jun 18, 2020
Merged

Docs: CLI documentation #210

merged 2 commits into from
Jun 18, 2020

Conversation

dinhtungdu
Copy link
Collaborator

Description of the Change

Add documentation for available CLI commands of Safe Redirect Manager. This PR adds a new section to the README.md file.

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests passed.

@dinhtungdu dinhtungdu added the needs:documentation This requires documentation. label Jun 18, 2020
@dinhtungdu dinhtungdu requested a review from jeffpaul June 18, 2020 10:59
@dinhtungdu dinhtungdu self-assigned this Jun 18, 2020
@jeffpaul jeffpaul added this to the 2.0.0 milestone Jun 18, 2020
jeffpaul
jeffpaul approved these changes Jun 18, 2020
View reviewed changes
Copy link
Member

@jeffpaul jeffpaul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some very minor tweaks to the description of the commands, but otherwise this is perfect thanks for getting these documented!

@jeffpaul jeffpaul merged commit a603049 into develop Jun 18, 2020
@jeffpaul jeffpaul deleted the docs/cli branch January 7, 2021 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeffpaul jeffpaul jeffpaul approved these changes

Assignees

@dinhtungdu dinhtungdu

Labels
needs:documentation This requires documentation.
Projects
None yet
Milestone
1.10.0
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@dinhtungdu @jeffpaul