developer-icons 4.0.1 → 4.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (2) hide show
  1. package/README.md +19 -15
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,39 +1,41 @@
1
1
  # Developer Icons
2
2
 
3
- `developer-icons` is a collection of ready-to-use high-quality customizable tech icons**for developers and designers**. Icon components are made **fully type-safe with typescript** and can be readily used in any React or Next.js projects with `developer-icons` npm package, or the icons can be manually downloaded in image formats to easily use in designs from the [official website](https://xandemon.github.io/developer-icons/ "Homepage | Developer Icons").
3
+ Welcome to **`developer-icons`**, a collection of high-quality, customizable tech icons designed for developers and designers. With full TypeScript support, these icons are perfect for use in any React or Next.js project. Alternatively, download the icons in image formats for your design needs directly from our [official website](https://xandemon.github.io/developer-icons/ "Homepage | Developer Icons").
4
4
 
5
5
  ## Features
6
6
 
7
- - **Highly optimized:** Icons are optimized for performance and size. They are designed to be as small as possible while maintaining the quality.
8
- - **Customizable:** Cusomizations are available for all icons. You can change the size, color, stroke width, and much more.
9
- - **Perfectly scalable:** Icons are designed to be properly scaled to any size without compromising the quality.
10
- - **Consistent icons:** No more dealing with inconsistent styles and designs. All icons are designed with a pre-defined set of rules.
11
- - **Various versions:** Icons come with their own set of families such as light and dark mode, wordmark, and other versions.
12
- - **Free & open-source:** Completely free and open-source with license. No need to worry about privately hidden malicious code and be a contributor yourself.
7
+ - ⚡**Highly optimized:** Icons are optimized for performance and size. They are designed to be as small as possible while maintaining the quality.
8
+ - 🎨**Customizable:** Cusomizations are available for all icons. You can change the size, color, stroke width, and much more.
9
+ - 🔍**Perfectly scalable:** Icons are designed to be properly scaled to any size without compromising the quality.
10
+ - 🔄**Consistent icons:** No more dealing with inconsistent styles and designs. All icons are designed with a pre-defined set of rules.
11
+ - 🌗**Various versions:** Icons come with their own set of families such as light and dark mode, wordmark, and other versions.
12
+ - ⭐**Free & open-source:** Completely free and open-source with license. No need to worry about privately hidden malicious code and be a contributor yourself.
13
+
14
+ Explore more and start using `developer-icons` today to enhance your projects with stunning, customizable icons!
13
15
 
14
16
  ## Installation
15
17
 
16
- To use the icons in your project, run the following command:
18
+ To add the icons to your project, run one of the following commands:
17
19
 
18
- ```
20
+ ```bash
19
21
  npm i developer-icons
20
22
  ```
21
23
 
22
24
  or
23
25
 
24
- ```
26
+ ```bash
25
27
  yarn add developer-icons
26
28
  ```
27
29
 
28
30
  or
29
31
 
30
- ```
32
+ ```bash
31
33
  pnpm add developer-icons
32
34
  ```
33
35
 
34
36
  ## Usage
35
37
 
36
- Import named icon components from the `developer-icons` package and use it as any other component with props/attributes similar to that of an svg:
38
+ Import named icon components from the `developer-icons` package and use them just like any other React component, with props/attributes similar to those of an SVG:
37
39
 
38
40
  ```javascript
39
41
  import { HtmlIcon, JavascriptIcon } from "developer-icons";
@@ -49,12 +51,14 @@ export const YourReactComponent = () => {
49
51
  };
50
52
  ```
51
53
 
52
- ## Contributing
54
+ In this example, we import `HtmlIcon` and `JavascriptIcon` from the `developer-icons` package and use them within a React component. You can customize the icons by adjusting their `size`, `color`, `style`, and other properties.
53
55
 
54
- Contributions are welcome! `Developer Icons` is just getting started and there is a lot more to come, so be a part of it.
56
+ ## Contributing
55
57
 
56
- If you have an icon to add or an improvement to suggest, please open a pull request or an issue.
58
+ We welcome contributions of all kinds, whether you're looking to add new icons, improve existing ones, or enhance the overall project. To get started, refer to our [Contributing Guidelines](https://xandemon.github.io/developer-icons/docs/contributing).
57
59
 
58
60
  ## License
59
61
 
60
62
  Licensed under MIT License and copyrights reserved.
63
+
64
+ For complete documentation, visit our [official documentation](https://xandemon.github.io/developer-icons/docs).
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "developer-icons",
3
3
  "description": "Ready-to-use high-quality customizable tech icons - made for the developers",
4
- "version": "4.0.1",
4
+ "version": "4.1.0",
5
5
  "type": "module",
6
6
  "homepage": "https://xandemon.github.io/developer-icons",
7
7
  "repository": {