pride-flags

pride-flags is a Node.js library that will render pride flags as html image

Table of Contents

• pride-flags
• pride-flags is a Node.js library that will render pride flags as html image
  • Table of Contents
  • Getting Started
    • Introduction
  • Installation
  • Usage
  • Contribution
  • Code of Conduct
  • License
  • MIT License

Getting Started

Introduction

pride-flags is a Node.js library that will render pride flags as html image . You can find it at https://npmjs.org/package/pride-flags

Installation

Install pride-flags locally via npm:

npm install pride-flags

Usage

Import it in a .js file and call the function

Use the following valid names to render the flag:

'agender'
'aromantic'
'asexual'
'bisexual'
'demiromantic'
'genderfluid'
'genderqueer'
'grayAsexual'
'grayromantic'
'intersex'
'lesbian'
'morecolor'
'nonBinary'
'pansexual'
'polyamory'
'rainbow'
'transgender'

const prideFlags = require("pride-flags");

prideFlags("bisexual");

Contribution

pride-flags is under development. More flags options will come soon, you are wellcome to collaborate.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

If you would like to see a feature implemented or want to contribute a new feature, you are welcome to open an issue to discuss it and we will be more than happy to help.

If you choose to make a contribution, please fork this repository, work on a feature and submit a pull request.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Code of Conduct

Respect others in all levels and expect to receive the same treatment back.

License

MIT License

Copyright (c) 2022 Sara A. Ferrer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.