Skip to content

Thoughts on adding some examples directly into the "Usage" section of the README? #4

Closed

Description

@aclima93

I noticed that there already appear to be some baked into the documentation, but that's not as visible.

Activity

  1. self-assigned this
    on Jun 22, 2023
  2. soumyamahunt commented on Jun 22, 2023

    @soumyamahunt
    Contributor

    Thanks @aclima93, I am thinking of adding usages as collapsible section so that it doesn't make the README huge, kind of like here in the Swift forum I posted. What are your thoughts on this?

  3. aclima93 commented on Jun 22, 2023

    @aclima93
    Author

    way more accessible 👍

  4. linked a pull request that will close this issuedoc: improved usage documentation #5on Jun 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions