Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
unimu-cic authored Nov 29, 2023
1 parent bc4c8f4 commit 9be911f
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<img width="100%" alt="aws-iconic" src="https://github.com/unimu-cic/aws-iconic/assets/125171539/424cbe8b-d500-45cf-bcf4-8eb1c7d8b908">

# aws-iconic
Library of AWS Icons based on official AWS icon assets, with support for React and Vue.

## React
To get started with the AWS Iconic library for React, first install the package from npm:
```bash
npm install @aws-iconic/react
```
Then you can import and use the icons in your React components:
```jsx
import AnalyticsArchAmazonAthena from '@aws-iconic/vue/esm/analytics/arch-amazon-athena';

export default {
components: {
AnalyticsArchAmazonAthena
},
template: `
<div>
<!-- Use the icon component -->
<AnalyticsArchAmazonAthena />
</div>
`
};
```
Here's how to group AWS icons in a React application:
[![image](https://github.com/unimu-cic/aws-iconic/assets/125171539/1ab8135a-74c9-486f-9a6a-50ea5e21da37)](https://codesandbox.io/s/react-aws-iconic-dgyjtr)



## Vue
To incorporate AWS Iconic in your Vue projects, install the Vue-specific package from npm:
```bash
npm install @aws-iconic/vue
```

Import icons as needed
```jsx
import AnalyticsArchAmazonAthena from '@aws-iconic/vue/esm/analytics/arch-amazon-athena';

export default {
components: {
AnalyticsArchAmazonAthena
},
template: `
<div>
<!-- Use the icon component -->
<AnalyticsArchAmazonAthena />
</div>
`
};
```
Here's how to group AWS icons in a Vue application:
[![image](https://github.com/unimu-cic/aws-iconic/assets/125171539/f04ecbb5-fb92-408a-943e-43e30d8c78b1)](https://codesandbox.io/s/vue3-aws-iconic-rpvw2n)

0 comments on commit 9be911f

Please sign in to comment.