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 README to include details on standalone usage of the tool. #17

Open
garg3133 opened this issue Dec 10, 2023 · 7 comments
Open

Update README to include details on standalone usage of the tool. #17

garg3133 opened this issue Dec 10, 2023 · 7 comments
Labels
good first issue Good for newcomers

Comments

@garg3133
Copy link
Member

Add a "Standalone" bullet point in the Usage section.

@garg3133 garg3133 added the good first issue Good for newcomers label Dec 10, 2023
@Dragonstac
Copy link

Hi I would love to work on this issue as I can see this is related to the issue #18 so if needed I can help on both of those.

@garg3133
Copy link
Member Author

Hey, before that, you can help with cleaning up the README by moving stuff into a separate space (maybe in a docs folder) and linking to them from README instead of having everything in the README itself.

For example, we could have Android usage in one file and iOS usage in the other file and the README should only contain the links to them.

Once the README is cleared, we can add other common sections to it, like a contributing guide, licence, etc.

@Dragonstac
Copy link

Dragonstac commented Feb 23, 2024

Yes I can absolutely help with that.
So for that should I open an issue regarding tidying up the README right ?
Also a reference README would be great

@garg3133
Copy link
Member Author

garg3133 commented Feb 23, 2024

Sure, you can open up a new issue.

For reference, just look at the README of other projects in Nightwatch.js org or any good big project outside of the org.

Mainly, we need the four sections:

  • Description of the project
  • Usage with some description at the top
  • Contributing (how to setup the project and contribute to it)
  • License

You can add more sections if you feel the need to.

@Dragonstac
Copy link

Sure

@Dragonstac
Copy link

created the issue

@joe-jangala
Copy link

I want to work on this issue..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants