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

Improve the README.md file #1362

Merged
merged 1 commit into from
Aug 23, 2022
Merged

Improve the README.md file #1362

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<img alt="GitHub issues by-label" src="https://img.shields.io/github/issues/devicons/devicon/request:icon?color=%2360be86&label=icon%20requests&style=for-the-badge">
</a>
<a href="https://github.com/devicons/devicon/stargazers">
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/devicons/devicon?color=%2360be86&label=github%20stars&style=for-the-badge">
<img alt="GitHub repository stars" src="https://img.shields.io/github/stars/devicons/devicon?color=%2360be86&label=github%20stars&style=for-the-badge">
</a>
</p>
<br />
Expand Down Expand Up @@ -51,7 +51,7 @@
<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-community">Discord community</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>
Expand Down Expand Up @@ -95,9 +95,9 @@ yarn add devicon
```

<p>
If you don't want to use a package manager you can also download
If you don't want to use a package manager, you can also download
and include <a href="/devicon.min.css">devicon.min.css</a> next to the <a href="/fonts">font files</a> to your project.
See <a href="https://devicon.dev">devicon.dev</a> for details about how to add devicon to your project via
See <a href="https://devicon.dev">devicon.dev</a> for details about how to add Devicon to your project via
a CDN.
</p>
<p>
Expand Down Expand Up @@ -136,7 +136,8 @@ yarn add devicon
<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 CSS rules in your stylesheet.

```css
.devicon-devicon-plain {
max-width: 2em;
Expand All @@ -154,7 +155,7 @@ Add css rules in your stylesheet
<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 an 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.
</p>
Expand All @@ -164,7 +165,7 @@ Add css rules in your stylesheet
We are happy with every contribution, whether it's new icons, features, or maintainers. Please have a look at our <a href="https://github.com/devicons/devicon/wiki">Wiki</a> to see how you can contribute to this project.
</p>

<h2 id="discord-server">Discord server</h2>
<h2 id="discord-community">Discord community</h2>
<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.
<b>Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub.</b>
Expand Down Expand Up @@ -207,7 +208,7 @@ After a pull request has been open for over 30 days with no activity or response
by yourself.
</p>
<h5>Prerequisites</h5>
<p>Install gulp (and gulp plugins)</p>
<p>Install <code>gulp</code> (and <code>gulp</code> plugins)</p>

```bash
npm install
Expand Down