diff --git a/README.md b/README.md new file mode 100644 index 00000000..cb64f128 --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +aws-iconic + +# 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: ` +
+ + +
+ ` +}; +``` +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: ` +
+ + +
+ ` +}; +``` +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)