Improve documentation in README.md - Githubissues

devongovett / regexgen

Generate regular expressions that match a set of strings

https://runkit.com/npm/regexgen

3.35k stars 100 forks source link

Improve documentation in README.md #34

Open MarianaTorresTorres opened 8 months ago

MarianaTorresTorres commented 8 months ago

Description: Contributed to the README.md to make it easier to understand all of the functionality available in the package.

Changes Made:

Added Table of Contents for better navigation.
Updated Installation section to redirect to npm package specifically instead of just npm's home page.
Added new API section to show the other functions users can use besides the ones already shown in the example code.