From 4470e153c119275bf63d3b2068a0dc05d44c0073 Mon Sep 17 00:00:00 2001 From: Artur Yorsh Date: Sat, 8 Jun 2019 16:18:03 +0300 Subject: [PATCH] release: v1.0.0-beta.1 --- README.md | 22 +++++++++++----------- lib/package.json | 2 +- package.json | 4 ++-- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index f728d22..076fc33 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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 diff --git a/lib/package.json b/lib/package.json index c8c2f9b..04b89b8 100644 --- a/lib/package.json +++ b/lib/package.json @@ -12,7 +12,7 @@ "svg" ], "author": "artyorsh", - "license": "ISC", + "license": "MIT", "bugs": { "url": "https://github.com/artyorsh/react-native-eva-icons/issues" }, diff --git a/package.json b/package.json index 51178b1..6aeb76b 100644 --- a/package.json +++ b/package.json @@ -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", @@ -29,7 +29,7 @@ "svg" ], "author": "artyorsh", - "license": "ISC", + "license": "MIT", "bugs": { "url": "https://github.com/artyorsh/react-native-eva-icons/issues" },