Skip to content

Commit

Permalink
Merge pull request #7 from MKAbuMattar/dev
Browse files Browse the repository at this point in the history
fix: readme, and more
  • Loading branch information
MKAbuMattar authored Apr 29, 2023
2 parents 5ca4158 + ab8e820 commit 2831dcb
Show file tree
Hide file tree
Showing 4 changed files with 8,123 additions and 7 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ build
icons
lib
svg
build.config.json
downloadedFile.zip

# .log files
Expand Down
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<h1>AWS React Icons</h1>

<a href="https://aws-react-icon.vercel.app/">https://aws-icon.vercel.app/</a>
<a href="https://aws-icon.vercel.app/">https://aws-icon.vercel.app/</a>

<br/>

Expand Down Expand Up @@ -34,7 +34,7 @@
</a>
</div>

## Install package
## 📦 Install package

```bash
#npm
Expand All @@ -47,7 +47,7 @@ yarn add aws-react-icons
pnpm add aws-react-icons
```

## Usage
## 📖 Usage

```tsx
// single import
Expand Down Expand Up @@ -82,12 +82,16 @@ const App = () => {
export default App;
```

## Props
## 📚 Icons Props

| Prop name | Type | Default value | Description |
| --------- | -------------- | ------------- | --------------------- |
| size | number/ string | 24 | The size of the icon. |

## License
## 📝 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 📜 Credits

- [AWS Architecture Icons](https://aws.amazon.com/architecture/icons/)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "aws-react-icons",
"version": "1.0.2",
"version": "1.0.3",
"description": "AWS React Icons, a React library for AWS icons based on the official AWS icon set (SVG) and built with TypeScript.",
"keywords": [
"aws",
Expand Down
Loading

0 comments on commit 2831dcb

Please sign in to comment.