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

Make proper usage documentation #110

Open
Privat33r-dev opened this issue Aug 27, 2024 · 0 comments
Open

Make proper usage documentation #110

Privat33r-dev opened this issue Aug 27, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Privat33r-dev
Copy link
Collaborator

Rationale

Currently the Documentation part of the Readme refers to the video. Video format might be less than perfect choice by multiple reason:

  • Accessibility: some people might have impaired hearing, while video has only autogenerated subtitles; others might not know language or have too slow internet connection
  • Usability: it's hard to use a video as a quick cheatsheet/referral for the tool usage. Some people might need just a small refresher on certain part
  • Maintainability: it's hard to edit video in case of changes

What should be included

  • Detailed description of flags (like --no-ssl)
  • Usage examples
  • Best practices
  • FAQ: common errors and their resolution
@Privat33r-dev Privat33r-dev added the enhancement New feature or request label Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant