Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 2 KB

README.md

File metadata and controls

69 lines (47 loc) · 2 KB

BP Color Library 🌈

BP Color Library is a lightweight and straightforward utility for developers to fetch color names by providing HEX color codes. Simplify your design and development workflows with this easy-to-use library.

🌟 Features

  1. Lightweight: Designed to be fast and minimal.
  2. Flexible: Works seamlessly with JavaScript and modern frameworks.
  3. Useful: Ideal for design systems, educational tools, or any project dealing with colors.

🛠 Usage

Run

npm i bp-color-library

Import

const { getColorName } = require('bp-color-library');

Testing

console.log(getColorName('#add8e6'));

📝 Documentation

Function : getColorName

  1. Parameters: hex (string): A valid HEX color code (e.g., #FF5733).
  2. Returns: string: The corresponding color name, or "Unknown color" if the HEX code is not recognized.

📦 Contributing

  1. Fork the repository.
  2. Create a new branch (feature/my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push your branch (git push origin feature/my-new-feature).
  5. Create a pull request to the main repository.

❤️ Support

  1. Giving the repository a ⭐ on GitHub.
  2. Sharing it with your friends and colleagues.
  3. Providing feedback or reporting issues to help us improve.
  4. Sponsor me on GitHub
    If you'd like to support my work, you can sponsor me on GitHub:
    Sponsor Bhathiya Prasad on GitHub
  5. If you enjoy my work, consider buying me a coffee to show your support: Buy Me a Coffee

Visit the repository here

BP Color Library GitHub Repository

📧 Feedback

If you have any questions, suggestions, or feedback, feel free to reach out:

  1. Open an issue on GitHub: GitHub Issues
  2. Contact the author: Bhathiya Prasad

final 2