Skip to content

Commit

Permalink
docs(readme): update the readme file in the project root (#5)
Browse files Browse the repository at this point in the history
- [x] review and update the root readme file contents;
  • Loading branch information
rfprod authored Dec 25, 2021
1 parent c161ddd commit af025b8
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is `NOT` a fork of the [material design icons](https://github.com/google/material-design-icons) by Google, including only the font files for smaller distribution.

This is a generator script which fetches icon fonts from the [original material design icons repo](https://github.com/google/material-design-icons), converts `otf` fonts to `woff`, and makes it possible to use self-hosted version of the latest material design icons for web.
This is a generator script which fetches iconfont from the [original material design icons repo](https://github.com/google/material-design-icons), converts `otf` fonts to `woff`, and makes it possible to use self-hosted version of the latest material design icons for web.

Fonts can be generated locally if this repo is cloned.

Expand All @@ -29,15 +29,18 @@ Read the [developer guide](http://google.github.io/material-design-icons/) on ho
The `iconfont` folder contains pre-generated font files that can be included in a project. This is especially convenient for the web; however, it is generally better to link to the web font hosted on Google Fonts:

```html
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
<link
href="https://fonts.googleapis.com/icon?family=Material+Icons"
rel="stylesheet"
/>
```

### Using self-hosted version

Install package.

```bash
npm i save-dev material-design-icon-fonts-self-hosted-web
npm i --save-dev material-design-icon-fonts-self-hosted-web
```

```bash
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "material-design-icon-fonts-self-hosted-web",
"version": "1.0.1",
"version": "1.0.2",
"description": "Self-hosted version generator of Google Material Design icon fonts for web apps.",
"keywords": [
"icons",
Expand Down

0 comments on commit af025b8

Please sign in to comment.