Skip to content

Commit 9f7a914

Browse files
committed
docs: update readme
1 parent 7ac0f33 commit 9f7a914

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<img src="packages/site/static/header-transparent.png" alt="Svelte Material UI" />
33
</div>
44

5-
A library of Svelte Material UI components, based on [Material Design Components - Web](https://material.io/develop/web/).
5+
A library of Svelte Material UI components, based on [Material Design Components - Web](https://github.com/material-components/material-components-web).
66

7-
# Demos and Code Samples
7+
# Demos, Code Samples, and Guides
88

99
https://sveltematerialui.com
1010

@@ -65,11 +65,13 @@ You can include icons in a number of ways, but the easiest is the [Material Icon
6565

6666
However, there are two downsides. First is that all icons are downloaded, no matter which ones you use, so the size over the wire will almost certainly be more than necessary. Second is that it _only_ includes the Material Icons from Google.
6767

68-
Another option is the [Material Design Icons library](https://materialdesignicons.com/). See the "Using SVGs" demo on the [Icon Button demo page](https://sveltematerialui.com/demo/icon-button) for instructions to use icons from the `@mdi/js` package (or any other SVG icons).
68+
Another option is the [Material Design Icons library](https://pictogrammers.com/library/mdi/). See the "Using SVGs" demo on the [Icon Button demo page](https://sveltematerialui.com/demo/icon-button) for instructions to use icons from the `@mdi/js` package (or any other SVG icons).
6969

7070
You can even use them in data URLs: [![](data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPCFET0NUWVBFIHN2ZyBQVUJMSUMgIi0vL1czQy8vRFREIFNWRyAxLjEvL0VOIiAiaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkIj4KPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2ZXJzaW9uPSIxLjEiICB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCI+CiAgIDxwYXRoIGZpbGw9IiMwMDAwMDAiIGQ9Ik0xMSwyM0EyLDIgMCAwLDEgOSwyMVYxOUgxNVYyMUEyLDIgMCAwLDEgMTMsMjNIMTFNMTIsMUMxMi43MSwxIDEzLjM5LDEuMDkgMTQuMDUsMS4yNkMxNS4yMiwyLjgzIDE2LDUuNzEgMTYsOUMxNiwxMS4yOCAxNS42MiwxMy4zNyAxNSwxNkEyLDIgMCAwLDEgMTMsMThIMTFBMiwyIDAgMCwxIDksMTZDOC4zOCwxMy4zNyA4LDExLjI4IDgsOUM4LDUuNzEgOC43OCwyLjgzIDkuOTUsMS4yNkMxMC42MSwxLjA5IDExLjI5LDEgMTIsMU0yMCw4QzIwLDExLjE4IDE4LjE1LDE1LjkyIDE1LjQ2LDE3LjIxQzE2LjQxLDE1LjM5IDE3LDExLjgzIDE3LDlDMTcsNi4xNyAxNi40MSwzLjYxIDE1LjQ2LDEuNzlDMTguMTUsMy4wOCAyMCw0LjgyIDIwLDhNNCw4QzQsNC44MiA1Ljg1LDMuMDggOC41NCwxLjc5QzcuNTksMy42MSA3LDYuMTcgNyw5QzcsMTEuODMgNy41OSwxNS4zOSA4LjU0LDE3LjIxQzUuODUsMTUuOTIgNCwxMS4xOCA0LDhaIiAvPgo8L3N2Zz4=)](https://www.youtube.com/watch?v=vo9Fja5x04o)
7171

72-
1. [Find your icon](https://materialdesignicons.com/) and click "View SVG" under the code menu.
72+
To get a data URL for the icon:
73+
74+
1. [Find your icon](https://pictogrammers.com/library/mdi/) and click "View SVG" under the code menu.
7375
2. Click the "SVG File" tab and copy the full SVG document.
7476
3. [Base64 encode](https://www.base64encode.org/) the document.
7577
4. Format the URL like this `data:image/svg+xml;base64,encodedcontent`, replacing "encodedcontent" with the Base64 results.
@@ -80,13 +82,15 @@ You can even use them in data URLs: [![](data:image/svg+xml;base64,PD94bWwgdmVyc
8082
Click a component/package below to go to the documentation. (Note that this documentation is a work in progress. The demo code should be your main source of truth for how something works.)
8183

8284
- [Accordion](packages/accordion/README.md)
83-
- [Badge](packages/badge/README.md)
84-
- [Banner](packages/banner/README.md)
85-
- [Bottom App Bar](packages/bottom-app-bar/README.md)
8685
- Action Buttons
8786
- [Button](packages/button/README.md)
8887
- [Floating Action Button](packages/fab/README.md)
8988
- [Icon Button](packages/icon-button/README.md)
89+
- App Bars
90+
- [Bottom App Bar](packages/bottom-app-bar/README.md)
91+
- [Top App Bar](packages/top-app-bar/README.md)
92+
- [Badge](packages/badge/README.md)
93+
- [Banner](packages/banner/README.md)
9094
- [Card](packages/card/README.md)
9195
- [Common](packages/common/README.md)
9296
- [Data Table](packages/data-table/README.md)
@@ -128,7 +132,6 @@ Click a component/package below to go to the documentation. (Note that this docu
128132
- [Tab](packages/tab/README.md)
129133
- [Tab Bar](packages/tab-bar/README.md)
130134
- [Tooltip](packages/tooltip/README.md)
131-
- [Top App Bar](packages/top-app-bar/README.md)
132135
- [Touch Target](packages/touch-target/README.md)
133136
- [Typography](https://sveltematerialui.com/demo/typography/)
134137

@@ -140,7 +143,7 @@ Click a component/package below to go to the documentation. (Note that this docu
140143

141144
# License
142145

143-
Copyright 2020-2021 Hunter Perrin
146+
Copyright 2019-2023 Hunter Perrin
144147

145148
Licensed under the Apache License, Version 2.0 (the "License");
146149
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)