Skip to content

Edit Readme for Ease of Use #91

Closed
Closed

Description

@samiam2013

The readme does a good job of explaining the use of enumer, comprehensive enough that you might not need more, but the actual use of the package is sort of below-the-fold or below what would be my first scroll. I'd like to add a very succinct example and the simplest instructions to install at the very start without removing any of the existing explanation(s). This would hopefully lower the bar for new and returning devs.

Activity

  1. self-assigned this
    on Jun 17, 2024
  2. samiam2013 commented on Aug 15, 2025

    @samiam2013
    ContributorAuthor

    this could be merged with #113

  3. removed their assignment
    on Apr 22, 2026
  4. dmarkham commented on Oct 3, 2026

    @dmarkham
    Owner

    Done in #126 and #127. The README now opens with a working example and the
    install steps, and the flag reference is in tables below it.

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

    enhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions