mirror of
https://github.com/konpa/devicon.git
synced 2025-08-29 17:20:09 +02:00
Update README.md (#1633)
* bump npm version to v2.15.1 * Update README.md Corrected a lot of grammatical errors, added appropriate punctuation to the readme. * Update README.md Co-authored-by: David Leal <halfpacho@gmail.com> * Update README.md Co-authored-by: Jørgen Kalsnes Hagen <43886029+Snailedlt@users.noreply.github.com> Co-authored-by: Clemens Bastian <8781699+amacado@users.noreply.github.com> Co-authored-by: Amacado <clemens.bastian@gmail.com> Co-authored-by: Thomas Bui <43018778+Thomas-Boi@users.noreply.github.com> Co-authored-by: David Leal <halfpacho@gmail.com> Co-authored-by: Jørgen Kalsnes Hagen <43886029+Snailedlt@users.noreply.github.com>
This commit is contained in:
52
README.md
52
README.md
@@ -24,7 +24,7 @@
|
|||||||
<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/devicon/devicon-original-wordmark.svg" alt="Devicon Logo" height="140" />
|
<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/devicon/devicon-original-wordmark.svg" alt="Devicon Logo" height="140" />
|
||||||
</a>
|
</a>
|
||||||
<h5 align="center">
|
<h5 align="center">
|
||||||
devicon aims to gather all logos representing development languages and tools.
|
Devicon aims to gather all logos representing development languages and tools.
|
||||||
</h5>
|
</h5>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a target="_blank" href="https://devicon.dev">Demo</a>
|
<a target="_blank" href="https://devicon.dev">Demo</a>
|
||||||
@@ -35,7 +35,7 @@
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<h2>TL;DR;</h2>
|
<h2>TL;DR</h2>
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<!-- in your header -->
|
<!-- in your header -->
|
||||||
@@ -47,17 +47,17 @@
|
|||||||
|
|
||||||
<h2>Table of Contents</h2>
|
<h2>Table of Contents</h2>
|
||||||
<ol>
|
<ol>
|
||||||
<li><a href="#about">About the project</a></li>
|
<li><a href="#about">About the Project</a></li>
|
||||||
<li><a href="#getting-started">Getting started</a></li>
|
<li><a href="#getting-started">Getting Started</a></li>
|
||||||
<li><a href="#request-icon">Requesting icon</a></li>
|
<li><a href="#request-icon">Requesting Icon</a></li>
|
||||||
<li><a href="#contribute">Contributing</a></li>
|
<li><a href="#contribute">Contributing</a></li>
|
||||||
<li><a href="#discord-community">Discord community</a></li>
|
<li><a href="#discord-community">Discord Community</a></li>
|
||||||
<li><a href="#develop-vs-master"><code>develop</code> vs <code>master</code></a></li>
|
<li><a href="#develop-vs-master"><code>develop</code> vs <code>master</code></a></li>
|
||||||
<li><a href="#stale-prs">Stale pull requests</a></li>
|
<li><a href="#stale-prs">Stale Pull Requests</a></li>
|
||||||
<li><a href="#build-yourself">Go build yourself</a></li>
|
<li><a href="#build-yourself">Go Build Yourself</a></li>
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
<h2 id="about">About the project</h2>
|
<h2 id="about">About the Project</h2>
|
||||||
<p>
|
<p>
|
||||||
Devicon aims to gather all logos representing development languages and tools.
|
Devicon aims to gather all logos representing development languages and tools.
|
||||||
Each icon comes in several versions: font/SVG, original/plain/line, colored/not colored, wordmark/no wordmark.
|
Each icon comes in several versions: font/SVG, original/plain/line, colored/not colored, wordmark/no wordmark.
|
||||||
@@ -67,20 +67,22 @@
|
|||||||
See the <a href="/devicon.json">devicon.json</a> or <a href="https://devicon.dev">our website</a> for complete and up to date reference of
|
See the <a href="/devicon.json">devicon.json</a> or <a href="https://devicon.dev">our website</a> for complete and up to date reference of
|
||||||
all available icons.
|
all available icons.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
Thanks to all our contributors and the <a href="https://icomoon.io/#home">IcoMoon app</a>. Devicon would not be possible without you.
|
||||||
|
</p>
|
||||||
|
|
||||||
<sub>
|
<sub>
|
||||||
All product names, logos, and brands are property of their respective owners. All company, product and service
|
All product names, logos, and brands are property of their respective owners. All company, product and service
|
||||||
names used in this website are for identification purposes only. Use of these names, logos, and brands does not
|
names used in this website are for identification purposes only. Use of these names, logos, and brands does not
|
||||||
imply endorsement. Usage of these logos should be done according to the company/brand/service's brand policy.
|
imply endorsement. Usage of these logos should be done according to the company/brand/service's brand policy.
|
||||||
</sub>
|
</sub>
|
||||||
<p>
|
|
||||||
Thank you to our contributors and the <a href="https://icomoon.io/#home">IcoMoon app</a>. Devicon would not be possible without you.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
|
|
||||||
<h2 id="getting-started">Getting started</h2>
|
<h2 id="getting-started">Getting Started</h2>
|
||||||
<p>
|
<p>
|
||||||
For a super fast setup go check <a href="https://devicon.dev">devicon.dev</a>.<br />
|
For a super fast setup go check <a href="https://devicon.dev">devicon.dev</a>.<br />
|
||||||
You can either <a href="#getting-started-svg">use the raw SVG</a> icons or our <a href="#getting-started-font">devicon font</a> (which is
|
You can either use the <a href="#getting-started-svg">raw SVG</a> icons or our <a href="#getting-started-font">devicon font</a> (which is
|
||||||
also available via CDN).
|
also available via CDN).
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
@@ -109,7 +111,7 @@ yarn add devicon
|
|||||||
<link rel="stylesheet" href="devicon.min.css">
|
<link rel="stylesheet" href="devicon.min.css">
|
||||||
```
|
```
|
||||||
|
|
||||||
<p>Start using icons with <code><i></code>-tag</p>
|
<p>Start using icons with <code><i></code>-tag:</p>
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<!-- for devicon plain version -->
|
<!-- for devicon plain version -->
|
||||||
@@ -126,17 +128,17 @@ yarn add devicon
|
|||||||
```
|
```
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
An alternate way to use <code>devicon</code> is by copy/paste the raw SVG code
|
An alternate way to use <code>devicon</code> is by copy/pasting the raw SVG code
|
||||||
to your project.
|
to your project.
|
||||||
</p>
|
</p>
|
||||||
<h4 id="getting-started-svg">Copy/paste SVG code (from the <a href="https://github.com/devicons/devicon/tree/master/icons">svg folder</a> or the <a href="https://devicon.dev">project page</a>)</h4>
|
<h4 id="getting-started-svg">Copy/paste SVG code (from the <a href="https://github.com/devicons/devicon/tree/master/icons">SVG folder</a> or the <a href="https://devicon.dev">project page</a>):</h4>
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<!-- for devicon plain version -->
|
<!-- for devicon plain version -->
|
||||||
<svg id="Devicon" class='devicon-devicon-plain' xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><path id="plain" fill="#60be86" d="M64,7.83H4.77L14.95,95.13l49,25,.06,0,49.07-25L123.23,7.83Zm42.77,54.86c0,.88,0,1.67-.77,2L73.25,80.44l-2.42,1.13-.27-3.15V72.23l.24-1.57,1.09-.47L95.07,59.81l-21.54-9.6L64.35,68.34,58.9,78.87l-1.22,2.27-2.05-.9L22,64.71a2.42,2.42,0,0,1-1.45-2V56.91a2.39,2.39,0,0,1,1.42-2l34-15.73,3.21-1.44v9.66l.24,1.34-1.56.7L34.45,59.79,56.3,69.42l8.05-16,6.21-12.65,1.13-2.28,1.81.91L106,54.89c.73.35.76,1.14.76,2Z"/></svg>
|
<svg id="Devicon" class='devicon-devicon-plain' xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><path id="plain" fill="#60be86" d="M64,7.83H4.77L14.95,95.13l49,25,.06,0,49.07-25L123.23,7.83Zm42.77,54.86c0,.88,0,1.67-.77,2L73.25,80.44l-2.42,1.13-.27-3.15V72.23l.24-1.57,1.09-.47L95.07,59.81l-21.54-9.6L64.35,68.34,58.9,78.87l-1.22,2.27-2.05-.9L22,64.71a2.42,2.42,0,0,1-1.45-2V56.91a2.39,2.39,0,0,1,1.42-2l34-15.73,3.21-1.44v9.66l.24,1.34-1.56.7L34.45,59.79,56.3,69.42l8.05-16,6.21-12.65,1.13-2.28,1.81.91L106,54.89c.73.35.76,1.14.76,2Z"/></svg>
|
||||||
```
|
```
|
||||||
|
|
||||||
Add CSS rules in your stylesheet.
|
Add the following CSS rules in your stylesheet:
|
||||||
|
|
||||||
```css
|
```css
|
||||||
.devicon-devicon-plain {
|
.devicon-devicon-plain {
|
||||||
@@ -149,7 +151,7 @@ Add CSS rules in your stylesheet.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
<h4>You can also use the <code>img</code> tag and referencing an svg directly from the repo.</h4>
|
<h4>You can also use the <code>img</code> tag and reference an SVG directly from the repository:</h4>
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<img src='https://cdn.jsdelivr.net/gh/devicons/devicon/icons/devicon/devicon-original.svg'>
|
<img src='https://cdn.jsdelivr.net/gh/devicons/devicon/icons/devicon/devicon-original.svg'>
|
||||||
@@ -157,7 +159,7 @@ Add CSS rules in your stylesheet.
|
|||||||
|
|
||||||
<h2 id="request-icon">Requesting an icon</h2>
|
<h2 id="request-icon">Requesting an icon</h2>
|
||||||
<p>
|
<p>
|
||||||
When you want to request an icon please feel free to create an issue. See our <a href="https://github.com/devicons/devicon/wiki/Requesting-an-Icon">Wiki</a> for more information.
|
When you want to request an icon please feel free to create an issue. Check out our <a href="https://github.com/devicons/devicon/wiki/Requesting-an-Icon">Wiki</a> for more information.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h2 id="contribute">Contributing</h2>
|
<h2 id="contribute">Contributing</h2>
|
||||||
@@ -167,8 +169,8 @@ Add CSS rules in your stylesheet.
|
|||||||
|
|
||||||
<h2 id="discord-community">Discord community</h2>
|
<h2 id="discord-community">Discord community</h2>
|
||||||
<p>
|
<p>
|
||||||
We have a Discord community for Devicons. You can easily request icons, discuss, and have a good time talking with the community members! Join today: https://discord.gg/hScy8KWACQ.
|
We have a Discord community for Devicons. You can easily request icons, discuss, and have a good time talking with the community members! Join today: https://discord.gg/hScy8KWACQ.</p>
|
||||||
<b>Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub.</b>
|
<p><b>Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub.</b>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h2 id="develop-vs-master"><code>develop</code> vs <code>master</code></h2>
|
<h2 id="develop-vs-master"><code>develop</code> vs <code>master</code></h2>
|
||||||
@@ -197,14 +199,14 @@ All official releases shall be in <code>master</code>. Any updates in between (i
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2 id="stale-prs">Stale pull requests</h2>
|
<h2 id="stale-prs">Stale Pull Requests</h2>
|
||||||
<p>
|
<p>
|
||||||
After a pull request has been open for over 30 days with no activity or response from the author, it'll be automatically marked as stale. We might fork your changes and merge the changes ourselves. Since GitHub tracks contributions by commits, you will be credited.
|
After a pull request has been open for over 30 days with no activity or response from the author, it'll be automatically marked as stale. We might fork your changes and merge the changes ourselves. Since GitHub tracks contributions by commits, you will be credited.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h2 id="build-yourself">Go build yourself</h2>
|
<h2 id="build-yourself">Go Build Yourself</h2>
|
||||||
<p>
|
<p>
|
||||||
Feel free to follow those steps when you want to build the font
|
Feel free to follow these steps when you want to build the font
|
||||||
by yourself.
|
by yourself.
|
||||||
</p>
|
</p>
|
||||||
<h5>Prerequisites</h5>
|
<h5>Prerequisites</h5>
|
||||||
|
Reference in New Issue
Block a user