@imdeepss/compassion-icon v1.0.1

Compassion Icon

compassion-icon is a React component library for icons, built with TypeScript.

Installation

You can install the package via npm:

npm install @imdeepss/compassion-icon

Or with Yarn:

yarn add @imdeepss/compassion-icon

Usage To use the icons in your React project, import the desired icon from the library:

import { CloseIcon, BoyIcon } from '@imdeepss/compassion-icon';

const App = () => (
  <div>
    <CloseIcon />
    <BoyIcon width="24" height="24" color="#000" />
  </div>
);

export default App;

Props Each icon component accepts the following props:

width (optional): The width of the icon. Default is "24". height (optional): The height of the icon. Default is "24". color (optional): The color of the icon. Default is "#000". error (optional): A custom error message (if needed). className (optional): Additional CSS classes. License This package is licensed under the MIT License.

Contributing Feel free to open issues and pull requests on GitHub.

Author Deepak K Vishwakarma

Customizing Your README

• Installation Instructions: Replace @imdeepss/compassion-icon with the actual name of your package.
• Usage Instructions: Include specific examples or details relevant to your package.
• Available Icons: List and describe each icon that your library includes.
• Props Section: Customize this section according to the props available in your icons.
• License: Ensure you have a LICENSE file in your project for the license mentioned.
• Contributing: Add details on how others can contribute if you are open to contributions.

Feel free to modify and expand the README as needed to better fit your project and audience. If you need any help with specific sections or additional information, just let me know!