get-projectz-readme-section-regex

    3.0.5 • Public • Published

    get-projectz-readme-section-regex

    npm version Linux macOS Windows compatible Build status Coverage status Dependency status Renovate enabled
    Open in Gitpod Buy Me a Coffee PayPal Patreon

    Returns a regex for Projectz readme sections depending on the section name.

    Install

    # npm
    $ npm install get-projectz-readme-section-regex
    
    # Yarn
    $ yarn add get-projectz-readme-section-regex

    Usage

    const getProjectzReadmeSectionRegex = require('get-projectz-readme-section-regex')
    
    getProjectzReadmeSectionRegex('BADGES').test('<!-- BADGES -->')
    // |> true
    
    getProjectzReadmeSectionRegex('BADGES').test('<!-- BADGES/ -->\nfoo bar baz<!-- /BADGES -->')
    // |> true
    
    getProjectzReadmeSectionRegex('BADGES').test('<!-- INSTALL -->')
    // |> false

    Contribute

    Are you missing something or want to contribute? Feel free to file an issue or a pull request! ⚙️

    Support

    Hey, I am Sebastian Landwehr, a freelance web developer, and I love developing web apps and open source packages. If you want to support me so that I can keep packages up to date and build more helpful tools, you can donate here:

    Buy Me a Coffee  If you want to send me a one time donation. The coffee is pretty good 😊.
    PayPal  Also for one time donations if you like PayPal.
    Patreon  Here you can support me regularly, which is great so I can steadily work on projects.

    Thanks a lot for your support! ❤️

    License

    MIT License © Sebastian Landwehr

    Install

    npm i get-projectz-readme-section-regex

    DownloadsWeekly Downloads

    1,071

    Version

    3.0.5

    License

    MIT

    Unpacked Size

    7.08 kB

    Total Files

    4

    Last publish

    Collaborators

    • dword-design