Skip to content

Commit 4edb59e

Browse files
authored
Merge pull request #3 from xandemon/deploy
Update README.md of developer-icons
2 parents 0c92e09 + f6ae82f commit 4edb59e

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# Developer Icons
22

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").
44

55
## Features
66

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.
1013

1114
## Installation
1215

@@ -30,7 +33,7 @@ pnpm add developer-icons
3033

3134
## Usage
3235

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:
3437

3538
```javascript
3639
import { HtmlIcon, JavascriptIcon } from "developer-icons";
@@ -40,7 +43,7 @@ export const YourReactComponent = () => {
4043
return (
4144
<div>
4245
<HtmlIcon className="html-icon" />
43-
<JavascriptIcon height={52} width={52} />
46+
<JavascriptIcon size={52} style={{ marginLeft: 20 }} />
4447
</div>
4548
);
4649
};

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"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",
55
"type": "module",
6-
"homepage": "https://github.com/xandemon/developer-icons",
6+
"homepage": "https://xandemon.github.io/developer-icons",
77
"repository": {
88
"type": "git",
99
"url": "https://github.com/xandemon/developer-icons",

0 commit comments

Comments
 (0)