Skip to content

Commit

Permalink
release: v1.0.0-beta.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Artur Yorsh committed Jun 8, 2019
1 parent 28000ca commit 4470e15
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

❤️ Clean and powerful [**Eva Icons**][link:eva-icons] implementation for **React Native** based on [react-native-svg][link:react-native-svg] elements.

## Installation

```bash
npm i react-native-eva-icons
```

This framework assumes you have already installed **react-native-svg**, but if not - you should [install it][link:react-native-svg:install] too.

## Usage

```tsx
Expand All @@ -12,15 +20,9 @@ export const GithubIcon = () => (
);
```

## Installation

This is Work In Progress package built with TypeScript 🤗.
For now, this is not available on any package manager like npm.
You can use it only with cloning original sources and linking it to your app.

## Customization

React Native Eva Icons are built with **react-native-svg** elements. All of the components can accept the same properties as SVG elements.
React Native Eva Icons are built with **react-native-svg** elements. All of the components can accept [the same properties as SVG elements][link:react-native-svg:props].

For example, you can change icon fill color with the following code

Expand All @@ -32,9 +34,7 @@ export const GithubIcon = () => (
);
```

## TODO

* There is a list of SVG attributes that are not supported by **react-native-svg**. To get more clean implementation, it should be replaced.

[link:eva-icons]: https://github.com/akveo/eva-icons
[link:react-native-svg]: https://github.com/react-native-community/react-native-svg
[link:react-native-svg:install]: https://github.com/react-native-community/react-native-svg#installation
[link:react-native-svg:props]: https://github.com/react-native-community/react-native-svg#common-props
2 changes: 1 addition & 1 deletion lib/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"svg"
],
"author": "artyorsh",
"license": "ISC",
"license": "MIT",
"bugs": {
"url": "https://github.com/artyorsh/react-native-eva-icons/issues"
},
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-native-eva-icons",
"version": "1.0.0",
"version": "1.0.0-beta.1",
"description": "Eva Icons for React Native",
"scripts": {
"start": "npm run gen:prepare && npm run gen:all && npm run lint:all",
Expand Down Expand Up @@ -29,7 +29,7 @@
"svg"
],
"author": "artyorsh",
"license": "ISC",
"license": "MIT",
"bugs": {
"url": "https://github.com/artyorsh/react-native-eva-icons/issues"
},
Expand Down

0 comments on commit 4470e15

Please sign in to comment.