diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8a4f7d6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Tranity + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..3c9dc95 --- /dev/null +++ b/README.md @@ -0,0 +1,117 @@ +

+ Antasena Icons +

+

+ A comprehensive library of React icons designed to help developers easily add scalable vector icons to their projects. +
+
+ + + + + + + + + + + + +

+

+ Home + - + Documentation +

+ +## Installation + +To install Antasena Icons, run the following command: + +```bash +$ yarn add antasena-icons +``` + +## Usage + +To use an icon in your React application, simply import the icon from the antasena-icons package and render it as a component: + +```typescript +import { IconName } from "antasena-icons"; + +export const MyComponent = () => { + return ( +
+ +
+ ); +}; +``` + +Find the name of the icon you want to use. Each icon in the library is named `Icon{name}`, where `name` is the name of the icon in PascalCase. For example, the icon for the "add" action is named `IconAdd`. + +## Customization + +### SVG props + +You can customize the color, size, and other properties of the icon by passing props to the component: + +```typescript +import { IconName } from "antasena-icons"; + +export const MyComponent = () => { + return ( +
+ +
+ ); +}; +``` + +### Tailwind CSS + +If you're using Tailwind CSS, you can use the `className` prop to apply Tailwind classes to the icon: + +```typescript +import { IconName } from "antasena-icons"; + +export const MyComponent = () => { + return ( +
+ +
+ ); +}; +``` + +### Style props + +You can also use the `style` prop to apply inline styles to the icon: + +```typescript +import { IconName } from "antasena-icons"; + +export const MyComponent = () => { + return ( +
+ +
+ ); +}; +``` + +## Contributing + +**TODO**: Add contributing guidelines + +Contributions to Antasena Icons are welcome and encouraged! To get started, please read the contributing guidelines. + +## Releasing + +For releasing a new version on GitHub and NPM you don't need to create a tag. Just update the `package.json` version number and push. + +For publishing a release candidate update your `package.json` with `1.3.4-rc.0` (`.1`, `.2`, ...). It also work if you do it from a branch that have an open PR on main. + +## License + +Antasena Icons is licensed under the MIT License. diff --git a/docs/ICON_LIST.md b/docs/ICON_LIST.md new file mode 100644 index 0000000..5c64ff9 --- /dev/null +++ b/docs/ICON_LIST.md @@ -0,0 +1,19 @@ +Alerts   feedback +Arrows +Charts +Communication +Development +Editor +Education +Files +Finance   eCommerce +General +Images +Layout +Maps   travel +Media   devices +Security +Shapes +Time +Users +Weather