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 @@ +
+ +
+
+ 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 ( +