Skip to content

Clean up README #649

Open
Open
@Qix-

Description

@Qix-

Debug has a simple API with a handful of static-/member-methods. It has been relatively unchanged since its conception (yes, users of 0.x can most likely upgrade to the latest major without any problems).

However, the README currently reflects a manual (nay, a bible) of integrated examples, etc. for a library that should be easily grok-able in just a few moments' time.

Not every method call needs three examples, nor does it need several paragraphs explaining the intricacies of how the method is useful.

Further, the use of screenshots is egregious. They add several pagefuls of redundant information.


Let's minimize the README to just:

  • Single screenshot (very top, centered)
  • Title; summary
  • Installation
  • Basic usage
  • API documentation
  • Examples
  • Open Collective et al
  • License

Activity

added
change-patchThis proposes or provides a change that requires a patch release
pr-welcomeThis issue has an approved change; a pull request would be appreciated
on Dec 19, 2018
added this to the 5.x milestone on Dec 19, 2018
RabiaSaid

RabiaSaid commented on Jun 21, 2022

@RabiaSaid

2.6.8

RabiaSaid

RabiaSaid commented on Jun 21, 2022

@RabiaSaid

4.3.4

linked a pull request that will close this issue on Jul 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    change-patchThis proposes or provides a change that requires a patch releasepr-welcomeThis issue has an approved change; a pull request would be appreciated

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Participants

    @Qix-@RabiaSaid

    Issue actions

      Clean up README · Issue #649 · debug-js/debug