diff --git a/README.md b/README.md index 15ef8025..3c30f779 100644 --- a/README.md +++ b/README.md @@ -1 +1,105 @@ -# proxy-icons \ No newline at end of file +# Proxy Icons - React Components for Your Project + +[![npm version](https://img.shields.io/npm/v/proxy-icons.svg?style=flat-square)](https://www.npmjs.com/package/proxy-icons) + +This library provides a collection of React components for commonly used icons. Easily integrate these icons into your React applications to enhance user experience. + +## Installation with CDN + +1. **Add CDN Link**: To integrate Proxy Icons into your project, copy the following CDN link and paste it within the `
` tag of your HTML document: + + ```html + + ``` + + Alternatively, you can download the proxy-icons.css file and include it in the `` tag of your HTML document. + +2. **Use Icons**: To use an icon, add an `` tag with the appropriate class name. The class name follows the convention: `pro-{name}-{style}`. + + ```html + + ``` + + Note: Replace `{name}` with the icon name and `{style}` with the desired style (e.g., line for outlined icons or fill for filled icons). + +3. **Sizing**: You can resize Proxy Icons using inline styles or predefined classes. For example: + + ```html + + ``` + + If you're using a CSS framework like Tailwind CSS or Bootstrap, you can apply their text sizing classes directly: + + ```html + + + + ``` + +## Installation with npm + +Install the Proxy Icons package using your preferred package manager: + +```bash +npm install proxy-icons +# or +yarn add proxy-icons +# or +pnpm install proxy-icons +``` + +## Usage + +1. Import the desired icon component: + +```javascript +import { ProUserFill } from 'proxy-icons'; +``` + +2. Use the icon component within your React component: + +```javascript +const MyComponent = () => { + return ( +Submit Issues or request
- +Documentation