Skip to content

Commit

Permalink
Update README to match version 0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
acnabricot committed May 25, 2023
1 parent 2767366 commit c90b916
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Kudos to Rinor Maloku and his original npm package, [azure-react-icons](https://
[![npm][npm-image]][npm-url]
![types][types-image]

[types-image]: https://img.shields.io/npm/types/azure-react-icons.svg?style=flat-square
[npm-image]: https://img.shields.io/npm/v/azure-react-icons.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/azure-react-icons
[types-image]: https://img.shields.io/npm/types/react-az-icons.svg?style=flat-square
[npm-image]: https://img.shields.io/npm/v/react-az-icons.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/react-az-icons

Azure Icons based on SVG format in the form of React Components, to simplify adding the icons on your React applications.

Expand All @@ -21,8 +21,8 @@ Azure Icons based on SVG format in the form of React Components, to simplify add

## Naming Convention

- All icons should be .svg files with names that start with Az. Any icons that has nothing to do with Azure, should not be included in this library.
- Azure Active Directory consitutes a special case to make it more distinguishable from Active Directory. AzAAD<XXX> looks like a repetition but this is intended.
- All icons should be .svg files with names that start with Az in the form of AzNameOfResource. Any icons that has nothing to do with Azure, should not be included in this library.
- Azure Active Directory consitutes a special case to make it more distinguishable from Active Directory. AzAADXxX looks like a repetition but this is intended.
- For every Azure service, there should be just one single icon to avoid ambiguity and increase user-friendliness.
- Capitalise the first letter and capitalise for each word the first letter, no punctuations between words in the names.

Expand All @@ -31,38 +31,39 @@ Azure Icons based on SVG format in the form of React Components, to simplify add
Install the components using [npm](https://www.npmjs.com/) or [Yarn](https://yarnpkg.com/en/)

```bash
npm i --save azure-react-icons
npm i --save react-az-icons
# or
yarn add azure-react-icons
yarn add react-az-icons
```

## Usage

Simply import the component into your file:

```
import {APIManagement} from 'azure-react-icons';
import {AzKubernetesServices} from 'react-az-icons';
```
And use it as any other react component:

```
<APIManagement size={128}/>
<AzKubernetesServices size={128}/>
```

Final result:

<img src="./images/api-management.png" width="128">
<img src="./images/az-kubernetes-services.png" width="128">


## Contributing
You found an issue or there is an icon missing? Here is how you can help:

1. Follow up on the [Setup Guide](./setup.md).
2. Add your icon and make your change,
Do you want to extend the icons library or fix an issue? Here is how you can help:

1. Follow the instructions of the [Setup Guide](./setup.md).
2. Add your icon and make your change.
3. Open a PR :wink:

## Feedback

Request new icons or file bugs under our [Github Issues](https://github.com/orangenet/azure-react-icons/issues/new).
Request new icons or file bugs under [Github Issues](https://github.com/byteknacker/react-az-icons/issues).

> :construction: The components for this library are auto generated and some of them may contain issues, please report those.
Binary file removed images/api-management.png
Binary file not shown.
Binary file added images/az-kubernetes-services.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c90b916

Please sign in to comment.