devicon-react-svg - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "devicon-react-svg",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "devicon-react-svg is an implementation of the Devicons icon library, which contains the logos of various popular programming languages, frameworks and design and development tools. devicon-react-svg returns a functional React component that, when passed the name of a Devicon as the icon prop, will render it as an inline svg.",
@@ -5,0 +5,0 @@ "main": "dist/devicon-react-svg.min.js",

README.md

 # devicon-react-svg
 
-**devicon-react-svg** is an implementation of the [Devicons](https://github.com/vorillaz/devicons) icon set by  Theodore Vorillas, which contains the logos of various popular programming languages, frameworks and design and development tools. 
+**devicon-react-svg** is an implementation of the [Devicons](https://github.com/vorillaz/devicons) icon library, which contains the logos of various popular programming languages, frameworks and design and development tools. 
 
-**devicon-react-svg** returns a functional React component that, when passed the name of a Devicon as the `icon` prop, will render the Devicon as an inline svg.
+**devicon-react-svg** returns a functional React component that, when passed the name of a Devicon as the `icon` prop, will render it as an inline svg.
 
+---
 ## Installation
@@ -16,3 +17,3 @@ To install with **npm**:
 ```
-
+---
 ## Usage
@@ -62,5 +63,47 @@ Import the default export from **devicon-react-svg** and use it in your JSX as you would any other React component. It accepts the prop `icon`, which should be the name of the Devicon as a string.
 ```
+
+##Additional exports
+ A list of the icon names accepted by the component can be found here, at the [Devicons cheatsheet](http://vorillaz.github.io/devicons/#/cheat), or can be returned as an array by using the package's `iconList` export. **devicon-react-svg** also exports the `RandomIcon` component to display a randomly chosen icon.
+
+```js
+import DevIcon, {iconList, RandomIcon} from "devicon-react-svg";
+
+console.log(`Here is a list of icon names used by this component: ${iconNames}`);
+
+const Demo = props => {
+    return (<RandomIcon />);
+}
+```
+
+---
 ## Credits
-All of the SVG files were taken directly from the [Devicon](https://github.com/konpa/devicon) library created by [konpa](https://github.com/konpa).
 
-React Devicon is an open source project created by [Fernando Poumián](https://github.com/fpoumian) and released under the **MIT license**.
+Thank you to [Theodore Vorillas](https://www.vorillaz.com/), who created the font and icon collection that this component is based on, and which is the source of all of the svg path data used in this package.
+
+You can find the original repository here: [Devicons](https://github.com/vorillaz/devicons).
+
+---
+## License
+
+#### Copyright © 2019 [Dennis Hodges](https://github.com/fermentationist) 
+
+
+__The MIT License__
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

505357

increased by0.34%

Number of lines in readme file

107

increased by67.19%

No dependency changes