Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
LelouchFR committed Jun 9, 2024
1 parent 80fa963 commit fe487a6
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
<h3 align="center">Showcase your skills on your GitHub or resumé with ease!</h3>
<hr>

> [!CAUTION]
> the link `https://go-skill-icons.vercel.app/api/icons` is no longer supported, please change your link to `https://go-skill-icons.vercel.app/icons`, we are sorry if this made you problems.
> changes about this has been introduced from #78.
# Docs

- [Docs](#docs)
Expand All @@ -31,10 +27,10 @@ Copy and paste the code block below into your readme to add the skills icon elem
Change the `?i=js,html,css` to a list of your skills separated by ","s! You can find a full list of icons [here](#icons-list).

```md
![My Skills](https://go-skill-icons.vercel.app/icons?i=js,html,css,wasm)
![My Skills](https://go-skill-icons.vercel.app/api/icons?i=js,html,css,wasm)
```

![My Skills](https://go-skill-icons.vercel.app/icons?i=js,html,css,wasm)
![My Skills](https://go-skill-icons.vercel.app/api/icons?i=js,html,css,wasm)

# Themed Icons

Expand All @@ -47,10 +43,10 @@ Change the `&theme=light` to either `dark` or `light`. The theme is the backgrou
**Light Theme Example:**

```md
![My Skills](https://go-skill-icons.vercel.app/icons?i=java,kotlin,nodejs,figma&theme=light)
![My Skills](https://go-skill-icons.vercel.app/api/icons?i=java,kotlin,nodejs,figma&theme=light)
```

![My Skills](https://go-skill-icons.vercel.app/icons?i=java,kotlin,nodejs&theme=light)
![My Skills](https://go-skill-icons.vercel.app/api/icons?i=java,kotlin,nodejs&theme=light)

# Icons Per Line

Expand All @@ -59,10 +55,10 @@ You can specify how many icons you would like per line! It's an optional argumen
Change the `&perline=3` to any number between 1 and 50.

```md
![My Skills](https://go-skill-icons.vercel.app/icons?i=aws,gcp,azure,react,vue,flutter&perline=3)
![My Skills](https://go-skill-icons.vercel.app/api/icons?i=aws,gcp,azure,react,vue,flutter&perline=3)
```

![My Skills](https://go-skill-icons.vercel.app/icons?i=aws,gcp,azure,react,vue,flutter&perline=3)
![My Skills](https://go-skill-icons.vercel.app/api/icons?i=aws,gcp,azure,react,vue,flutter&perline=3)

# Get Icons Names

Expand All @@ -71,10 +67,10 @@ You can get the possiblity to add the name of the icons you put to help others t
The value of `titles` is a boolean, so it should be `true` or `false`, default is `false`

```md
![My Skills](https://go-skill-icons.vercel.app/icons?i=rust,surrealdb,actix,yew&titles=true)
![My Skills](https://go-skill-icons.vercel.app/api/icons?i=rust,surrealdb,actix,yew&titles=true)
```

![My Skills](https://go-skill-icons.vercel.app/icons?i=rust,surrealdb,actix,yew&titles=true)
![My Skills](https://go-skill-icons.vercel.app/api/icons?i=rust,surrealdb,actix,yew&titles=true)

# Centering Icons

Expand All @@ -83,14 +79,14 @@ Want to center the icons in your readme? The SVGs are automatically resized, so
```html
<p align="center">
<a href="https://go-skill-icons.vercel.app/">
<img src="https://go-skill-icons.vercel.app/icons?i=git,kubernetes,docker,c,vim" />
<img src="https://go-skill-icons.vercel.app/api/icons?i=git,kubernetes,docker,c,vim" />
</a>
</p>
```

<p align="center">
<a href="https://go-skill-icons.vercel.app/">
<img src="https://go-skill-icons.vercel.app/icons?i=git,kubernetes,docker,c,vim" />
<img src="https://go-skill-icons.vercel.app/api/icons?i=git,kubernetes,docker,c,vim" />
</a>
</p>

Expand Down

0 comments on commit fe487a6

Please sign in to comment.