Skip to content

Commit

Permalink
update README.md with more concise information about icons
Browse files Browse the repository at this point in the history
  • Loading branch information
vaga committed Oct 19, 2024
1 parent 525e793 commit 584b70c
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Main features:
- Customizable menu on sidebar
- Customizable social media links on sidebar
- Optimized for performance 100/100 on Lighthouse
- All feather icons included
- All Feather and Simple Icons icons included

## Getting started

Expand Down Expand Up @@ -80,14 +80,13 @@ If you want the above theme colors, you can see the [exampleSite/config.toml](/e

### Icons

This theme uses two libraries for icons.
**Feather Icons** is used for application-related icons, providing a clean and minimal design.
For brand icons, **Simple Icons** is used.
This theme uses two libraries for icons:

To differentiate brand icons from regular ones, the prefix `brand-` is added
to all icons from the **Simple Icons** library (e.g., brand-github, brand-x, brand-mastodon).
- [Feather](https://feathericons.com/) is used for application-related icons.
- [Simple Icons](https://simpleicons.org) is used for brand icons.

This helps keep the icons organized and easy to manage.
To differentiate brand icons from regular ones, the prefix `brand-` is added
to all icons from the Simple Icons library. (e.g., brand-github, brand-x, brand-mastodon...)

### Styling

Expand Down

0 comments on commit 584b70c

Please sign in to comment.