developer-icons 3.1.0 → 3.1.2

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 (2) hide show
  1. package/README.md +9 -6
  2. package/package.json +4 -3
package/README.md CHANGED
@@ -1,12 +1,15 @@
1
1
  # Developer Icons
2
2
 
3
- `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.
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").
4
4
 
5
5
  ## Features
6
6
 
7
- - **High-Quality Icons**: A curated set of icons suitable for various development projects.
8
- - **Easy to Use**: Icons are organized and can be easily integrated into projects as react components.
9
- - **Open Source**: Freely available for personal and commercial use, adhering to specified licenses.
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.
10
13
 
11
14
  ## Installation
12
15
 
@@ -30,7 +33,7 @@ pnpm add developer-icons
30
33
 
31
34
  ## Usage
32
35
 
33
- Import named icon components from the `developer-icons` package and use it as any other component with props similar to that of an svg:
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:
34
37
 
35
38
  ```javascript
36
39
  import { HtmlIcon, JavascriptIcon } from "developer-icons";
@@ -40,7 +43,7 @@ export const YourReactComponent = () => {
40
43
  return (
41
44
  <div>
42
45
  <HtmlIcon className="html-icon" />
43
- <JavascriptIcon height={52} width={52} />
46
+ <JavascriptIcon size={52} style={{ marginLeft: 20 }} />
44
47
  </div>
45
48
  );
46
49
  };
package/package.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "name": "developer-icons",
3
- "description": "Ready-to-use high quality scalable vector icons for developers and designers",
4
- "version": "3.1.0",
3
+ "description": "Ready-to-use high-quality customizable tech icons - made for the developers",
4
+ "version": "3.1.2",
5
5
  "type": "module",
6
- "homepage": "https://github.com/xandemon/developer-icons",
6
+ "homepage": "https://xandemon.github.io/developer-icons",
7
7
  "repository": {
8
8
  "type": "git",
9
9
  "url": "https://github.com/xandemon/developer-icons",
@@ -33,6 +33,7 @@
33
33
  "dev": "vite",
34
34
  "clean": "rimraf --glob dist && rimraf --glob lib/icons/*.tsx",
35
35
  "build": "npm run clean && tsx ./lib/scripts/build.ts && tsc --p ./tsconfig-build.json && vite build",
36
+ "build:docs": "cd docs && npm run build",
36
37
  "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
37
38
  "preview": "vite preview",
38
39
  "prePublishOnly": "npm run build",