Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #1633

Merged
merged 7 commits into from
Jan 26, 2023
Merged

Update README.md #1633

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e7a43b9
Merge pull request #1084 from devicons/develop
amacado Mar 22, 2022
619c806
bump npm version to v2.15.1
amacado Mar 22, 2022
1119b9f
Merge pull request #1085 from devicons/draft-release
Thomas-Boi Mar 23, 2022
106a4fd
Update README.md
Ishaan2053 Jan 18, 2023
357c990
Update README.md
Ishaan2053 Jan 19, 2023
c7b1ffc
Merge branch 'develop' into patch-1
Panquesito7 Jan 19, 2023
33b1bd9
Update README.md
Ishaan2053 Jan 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 28 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/devicon/devicon-original-wordmark.svg" alt="Devicon Logo" height="140" />
</a>
<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>
<p align="center">
<a target="_blank" href="https://devicon.dev">Demo</a>
Expand All @@ -35,7 +35,7 @@
</p>
</div>

<h2>TL;DR;</h2>
<h2>TL;DR</h2>

```html
<!-- in your header -->
Expand All @@ -47,17 +47,17 @@

<h2>Table of Contents</h2>
<ol>
<li><a href="#about">About the project</a></li>
<li><a href="#getting-started">Getting started</a></li>
<li><a href="#request-icon">Requesting icon</a></li>
<li><a href="#about">About the Project</a></li>
<li><a href="#getting-started">Getting Started</a></li>
<li><a href="#request-icon">Requesting Icon</a></li>
<li><a href="#contribute">Contributing</a></li>
<li><a href="#discord-server">Discord server</a></li>
<li><a href="#discord-server">Discord Server</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="#build-yourself">Go build yourself</a></li>
<li><a href="#stale-prs">Stale Pull Requests</a></li>
<li><a href="#build-yourself">Go Build Yourself</a></li>
</ol>

<h2 id="about">About the project</h2>
<h2 id="about">About the Project</h2>
<p>
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.
Expand All @@ -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
all available icons.
</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>
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
imply endorsement. Usage of these logos should be done according to the company/brand/service's brand policy.
</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>
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
Ishaan2053 marked this conversation as resolved.
Show resolved Hide resolved
also available via CDN).
</p>

Expand Down Expand Up @@ -109,7 +111,7 @@ yarn add devicon
<link rel="stylesheet" href="devicon.min.css">
```

<p>Start using icons with <code>&lt;i&gt;</code>-tag</p>
<p>Start using icons with <code>&lt;i&gt;</code>-tag:</p>

```html
<!-- for devicon plain version -->
Expand All @@ -126,17 +128,17 @@ yarn add devicon
```

<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.
</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
<!-- 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>
```

Add css rules in your stylesheet
Add the following CSS rules in your stylesheet:
```css
.devicon-devicon-plain {
max-width: 2em;
Expand All @@ -148,15 +150,15 @@ 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
<img src='https://cdn.jsdelivr.net/gh/devicons/devicon/icons/devicon/devicon-original.svg'>
```

<h2 id="request-icon">Requesting icon</h2>
<h2 id="request-icon">Requesting Icon</h2>
<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>

<h2 id="contribute">Contributing</h2>
Expand All @@ -166,8 +168,8 @@ Add css rules in your stylesheet

<h2 id="discord-server">Discord server</h2>
<p>
We are running a Discord server. You can go here to talk, discuss, and more with the maintainers and other people, too. Here's the invitation: https://discord.gg/hScy8KWACQ.
<b>Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub.</b>
We are running a Discord server. You can go there to talk, discuss, and more with the maintainers and other people, too. Here's the invitation: https://discord.gg/hScy8KWACQ.</p>
<p><b>Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub.</b>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Relevant, but for another discussion/issue: is the Discord server still unofficial? I think we should state it as official now.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, didn't see this comment before merging, but yes... I agree. The Discord server should be considered official

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#1641 PR fixes this🙂, mentioning the server as official.

</p>

<h2 id="develop-vs-master"><code>develop</code> vs <code>master</code></h2>
Expand Down Expand Up @@ -196,14 +198,14 @@ All official releases shall be in <code>master</code>. Any updates in between (i
</li>
</ul>

<h2 id="stale-prs">Stale pull requests</h2>
<h2 id="stale-prs">Stale Pull Requests</h2>
<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.
</p>

<h2 id="build-yourself">Go build yourself</h2>
<h2 id="build-yourself">Go Build Yourself</h2>
<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.
</p>
<h5>Prerequisites</h5>
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "devicon",
"version": "2.15.0",
"version": "2.15.1",
"description": "Programming related icons collection",
"main": "devicon.min.css",
"scripts": {
Expand Down