Skip to content

Commit

Permalink
Release v3.13.1
Browse files Browse the repository at this point in the history
# Fix

- (Re)add colorless example to the Usage section
  • Loading branch information
ericcornelissen authored Jan 3, 2021
2 parents 315a1bf + 07fa719 commit 5711635
Show file tree
Hide file tree
Showing 6 changed files with 48 additions and 23 deletions.
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
root=true

[*]
charset=utf-8
insert_final_newline=true

[LICENSE.md]
indent_size=unset
indent_style=space

[*.{json,yml}]
indent_size=2
indent_style=space
3 changes: 1 addition & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@
package-lock.json -diff

# Don't export/archive these files
.* export-ignore
CONTRIBUTING.md export-ignore
.github export-ignore
50 changes: 31 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,37 @@
# Contribution guide
# Contributing to Simple Icons Font

## 1. Versioning
This package is being versioned analog to the `simple-icons` package.
This ensures that installing a version of this package also uses the icons of the `simple-icons` package with the same
version.
Simple Icons welcomes contributions and corrections. Before contributing, please make sure you have read the guidelines below. If you decide to contribute anything, please do the following:

Please keep in mind to update the version of this package using the `npm version` command **after** a new version of
`simple-icons` is being released.
1. Fork this repository
1. Create [a new branch][github flow] from the latest `develop`
1. Start hacking on the new branch
1. Commit and push to the new branch
1. Make a pull request

## Local Development

## 2. Building
### Building Font Locally

1. Building the font
```bash
npm run build
```
* Make sure you have [NodeJS] installed. At least version 12.0.0 is required.
* Install the dependencies using `$ npm install`.
* Build the font using `$ npm run build`.
* The font files can be found in the `font/` directory.

1. Building the test page
```bash
npm run build:testpage
```

**NOTE:** Using `npm version` or `npm publish` will call the `prepublish` hook which will also build the project
automatically.
### Testing Font Locally

* Make sure you have [NodeJS] installed. At least version 12.0.0 is required.
* Install the dependencies using `$ npm install`.
* Build the font and the test page using `$ npm test`.
* Your browser will be opened at `http://localhost:8000/` where all icons should be displayed.

---

# Versioning

This package is being versioned analog to the `simple-icons` package, the details of which can be found in [the contributing guidelines][simple-icons versioning].

Additionally, patches may be used for non-breaking improvements to the font and major releases may be used to introduce breakings changes beyond removed icons.

[github flow]: https://guides.github.com/introduction/flow/
[NodeJS]: https://nodejs.org/en/download/
[simple-icons versioning]: https://github.com/simple-icons/simple-icons/blob/develop/CONTRIBUTING.md#versioning
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Use any of the icons available in simple-icons by adding the following classes t
Where `[ICON NAME]` is replaced by the icon name, for example:

```html
<i class="si si-simpleicons"></i>
<i class="si si-simpleicons si--color"></i>
```

Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "simple-icons-font",
"version": "3.13.0",
"version": "3.13.1",
"description": "Icon font generated from https://simpleicons.org",
"homepage": "https://www.simpleicons.org",
"keywords": [
Expand Down

0 comments on commit 5711635

Please sign in to comment.