Merge pull request #5 from tranityproject/ayungavis/2-create-readme

Create readme, license, and icon list

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.

README.md

@@ -0,0 +1,117 @@
+<p align="center">
+    <img width="1200" alt="Antasena Icons" src="https://user-images.githubusercontent.com/4987902/228852549-5e427c38-8903-4846-a3a9-c53c09421b5a.png"> 
+</p>
+<p align="center">
+    <i>A comprehensive library of React icons designed to help developers easily add scalable vector icons to their projects.</i>
+    <br>
+    <br>
+    <a href="https://github.com/tranityproject/antasena-icons/actions">
+      <img src="https://github.com/tranityproject/antasena-icons/workflows/ci/badge.svg?branch=main">
+    </a>
+    <a href="https://bundlephobia.com/package/antasena-icons">
+      <img src="https://img.shields.io/bundlephobia/minzip/antasena-icons">
+    </a>
+    <a href="https://www.npmjs.com/package/antasena-icons">
+      <img src="https://img.shields.io/npm/dw/antasena-icons">
+    </a>
+    <a href="https://github.com/tranityproject/antasena-icons/blob/main/LICENSE">
+      <img src="https://img.shields.io/npm/l/antasena-icons">
+    </a>
+</p>
+<p align="center">
+  <a href="https://github.com/tranityproject/antasena-icons">Home</a>
+  -
+  <a href="https://github.com/tranityproject/antasena-icons">Documentation</a>
+</p>
+
+## 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 (
+    <div>
+      <IconName />
+    </div>
+  );
+};
+```
+
+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 (
+    <div>
+      <IconName color="red" size={24} />
+    </div>
+  );
+};
+```
+
+### 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 (
+    <div>
+      <IconName className="text-red-500" />
+    </div>
+  );
+};
+```
+
+### 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 (
+    <div>
+      <IconName style={{ color: "red" }} />
+    </div>
+  );
+};
+```
+
+## 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.

docs/ICON_LIST.md

@@ -0,0 +1,19 @@
+<img width="1144" alt="Alerts   feedback" src="https://user-images.githubusercontent.com/4987902/228855367-ae6d5a8c-b29a-42cb-bcc5-869f7155bd54.png">
+<img width="1144" alt="Arrows" src="https://user-images.githubusercontent.com/4987902/228855380-701a4f69-c108-4e98-aa24-53d9de4a769d.png">
+<img width="1144" alt="Charts" src="https://user-images.githubusercontent.com/4987902/228855391-2ef86a87-6ed1-4408-842a-8a84611b1f64.png">
+<img width="1144" alt="Communication" src="https://user-images.githubusercontent.com/4987902/228855400-00715f0b-516b-47e3-84a8-ee245b20f8b8.png">
+<img width="1144" alt="Development" src="https://user-images.githubusercontent.com/4987902/228855410-0bba196b-fba0-4e1a-b500-10a67c8dff79.png">
+<img width="1144" alt="Editor" src="https://user-images.githubusercontent.com/4987902/228855415-c88c80f3-a817-4744-bed5-a540d95209f8.png">
+<img width="1144" alt="Education" src="https://user-images.githubusercontent.com/4987902/228855422-e6676178-1e2f-4195-8089-a378ea1bd320.png">
+<img width="1144" alt="Files" src="https://user-images.githubusercontent.com/4987902/228855425-a1d118a4-ae58-4953-80da-c68c5213b42e.png">
+<img width="1144" alt="Finance   eCommerce" src="https://user-images.githubusercontent.com/4987902/228855430-cc9fb72d-27eb-46b3-95f6-c5314d2bfb4e.png">
+<img width="1144" alt="General" src="https://user-images.githubusercontent.com/4987902/228855433-cb708c9b-d4e8-435a-9a2d-4997e0b74725.png">
+<img width="1144" alt="Images" src="https://user-images.githubusercontent.com/4987902/228855437-3cc31e2f-a620-450e-b2a2-b13e8d00c4fd.png">
+<img width="1144" alt="Layout" src="https://user-images.githubusercontent.com/4987902/228855440-0506b34f-1f7a-4c27-bd54-1275cf41f2e4.png">
+<img width="1144" alt="Maps   travel" src="https://user-images.githubusercontent.com/4987902/228855441-01b966ed-e8d9-42bd-8d24-81de306f4e35.png">
+<img width="1144" alt="Media   devices" src="https://user-images.githubusercontent.com/4987902/228855447-2880ae20-5003-446f-ae94-180754aeefa1.png">
+<img width="1144" alt="Security" src="https://user-images.githubusercontent.com/4987902/228855450-5283ecc6-3a34-4525-b3e0-fcfb9ed0f3cc.png">
+<img width="1144" alt="Shapes" src="https://user-images.githubusercontent.com/4987902/228855454-ccd3e179-0607-478c-8674-75fb282e7fae.png">
+<img width="1144" alt="Time" src="https://user-images.githubusercontent.com/4987902/228855455-abed8ad7-bd14-46ca-a488-0a0699891a97.png">
+<img width="1144" alt="Users" src="https://user-images.githubusercontent.com/4987902/228855458-9896eb0b-5d04-4cfa-9d2b-8fb2f0d2b9e4.png">
+<img width="1144" alt="Weather" src="https://user-images.githubusercontent.com/4987902/228855464-c5f11b9b-109f-4c5c-8dfb-1bc956394539.png">