Skip to content
This repository was archived by the owner on Oct 11, 2021. It is now read-only.
This repository was archived by the owner on Oct 11, 2021. It is now read-only.

Add a goal section to the readme #24

@RunDevelopment

Description

@RunDevelopment

When I first started this project, it was just a collection of simple rules I came up with to make reviewing regexes easier. But as the project grew and rules became more numerous, my focus started to shift. While the vague promise of "writing better regular expressions" may have been a good umbrella for what I've been doing until now, it doesn't describe the function and goals of the project at all.

Task:

  • Describe in a few sentences in plain English what the purpose of this plugin is and how it tries to achieve its goals.
  • List non-goals and make it clear that this plugin is opinionated.
  • Be brief!

The section will be placed directly below the slogan, so people don't have to search for this information.

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