developer-icons 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +28 -8
  3. package/package.json +5 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Sandesh Katwal aka xandemon
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  ## About
4
4
 
5
- `Developer Icons` is a collection of ready-to-use high-quality vector icons for developers and designers.
5
+ `Developer Icons` is a collection of ready-to-use high-quality vector icons for developers and designers. Fully customizable options with props, className, inline styles, etc. and completely typescript-supported components.
6
6
 
7
7
  ## Features
8
8
 
@@ -14,26 +14,46 @@
14
14
 
15
15
  To use the icons in your project, run the following command:
16
16
 
17
- ```bash
17
+ ```
18
18
  npm i developer-icons
19
19
  ```
20
20
 
21
+ or
22
+
23
+ ```
24
+ yarn add developer-icons
25
+ ```
26
+
27
+ or
28
+
29
+ ```
30
+ pnpm add developer-icons
31
+ ```
32
+
21
33
  ## Usage
22
34
 
23
35
  Import named icon components from the `developer-icons` package and use it as any other component with props similar to that of an svg:
24
36
 
25
37
  ```javascript
26
- import {HtmlIcon, JavascriptIcon} from "developer-icons";
38
+ import { HtmlIcon, JavascriptIcon } from "developer-icons";
27
39
 
28
40
  //inside your React component JSX
29
- <HtmlIcon className="html-icon" />
30
- <JavascriptIcon height={52} width={52} />
41
+ export const ReactComponent = () => {
42
+ return (
43
+ <div>
44
+ <HtmlIcon className="html-icon" />
45
+ <JavascriptIcon height={52} width={52} />
46
+ </div>
47
+ );
48
+ };
31
49
  ```
32
50
 
33
51
  ## Contributing
34
52
 
35
- Contributions are welcome! If you have an icon to add or an improvement to suggest, please open a pull request or an issue.
53
+ Contributions are welcome! `Developer Icons` is just getting started and there is a lot more to come, so be a part of it.
54
+
55
+ If you have an icon to add or an improvement to suggest, please open a pull request or an issue.
36
56
 
37
- ## Acknowledgments
57
+ ## License
38
58
 
39
- Thanks to all the contributors who have helped in creating and maintaining this icon collection.
59
+ Licensed under MIT License and copyrights reserved.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "developer-icons",
3
3
  "description": "Ready-to-use high quality vector icons for developers and designers",
4
- "version": "1.0.2",
4
+ "version": "1.0.3",
5
5
  "type": "module",
6
6
  "homepage": "https://github.com/xandemon/developer-icons",
7
7
  "repository": {
@@ -10,6 +10,7 @@
10
10
  "directory": ""
11
11
  },
12
12
  "author": "xandemon",
13
+ "license": "MIT",
13
14
  "keywords": [
14
15
  "developer icons",
15
16
  "tech stack icons",
@@ -58,5 +59,8 @@
58
59
  "vite": "^5.2.0",
59
60
  "vite-plugin-dts": "^3.9.0",
60
61
  "vite-plugin-lib-inject-css": "^2.0.1"
62
+ },
63
+ "dependencies": {
64
+ "developer-icons": "^1.0.2"
61
65
  }
62
66
  }