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

Tidy up README and add subcommand instructions #68

Merged
merged 11 commits into from
Sep 12, 2024

Conversation

itsspriyansh
Copy link
Contributor

@itsspriyansh itsspriyansh commented Sep 3, 2024

This PR

  • adds information about available subcommands and dotcommands in README.md.
  • Adds Information about standalone setup in README.md.
  • Moves the app and web testing docs to separate files.

@garg3133
Copy link
Member

garg3133 commented Sep 3, 2024

@itsspriyansh We'd need to reduce the README to only the most important information and move all the detailed information to separate pages. Otherwise, someone exploring this project would never reach the part you've implemented through the readme.

See #30 for reference.

@itsspriyansh
Copy link
Contributor Author

@garg3133 PR updated. How does it look now?

@garg3133
Copy link
Member

garg3133 commented Sep 3, 2024

@itsspriyansh Not what I meant. What I meant was to move the detailed usage sections of setting up Android/iOS requirements to separate files (as was attempted in #30 but then the author abandoned the PR) so that the README is freed up and only contains the important details.

The amount of information that you added earlier in README related to your work seemed alright, we should have some basic usage about each subcommand in the main readme itself and then move the rest to corresponding files.

@itsspriyansh itsspriyansh changed the title add: subcommand instructions in README Tidy up README and add subcommand instructions Sep 4, 2024
@itsspriyansh
Copy link
Contributor Author

@garg3133 PR updated

Copy link
Member

@garg3133 garg3133 left a comment

Choose a reason for hiding this comment

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

The README looks good now.

@garg3133 garg3133 merged commit 019f42b into nightwatchjs:main Sep 12, 2024
2 checks passed
@garg3133
Copy link
Member

What's left now is to link the specific subcommand docs with the appropriate sections in README and update the subcommand files for the recently merged scripts.

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

Successfully merging this pull request may close these issues.

2 participants