diff --git a/.gitignore b/.gitignore index 7d3cec2..9866ef4 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,7 @@ # production /build +/dist # misc .DS_Store diff --git a/README.md b/README.md index 95d71ae..5458d75 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Phosphor is a flexible icon family for interfaces, diagrams, presentations — whatever, really. -- 1047 icons and counting +- 1,248 icons and counting - 6 weights: **Thin**, **Light**, **Regular**, **Bold**, **Fill**, and **Duotone** - Designed at 16 x 16px to read well small and scale up big - Raw stroke information retained to fine-tune the style @@ -13,9 +13,9 @@ More ways to use at [phosphoricons.com](https://phosphoricons.com). ## For developers -Phosphor is available as a [one-liner](https://github.com/phosphor-icons/phosphor-icons) script, [React package](https://github.com/phosphor-icons/phosphor-react), and [Vue package](https://github.com/phosphor-icons/phosphor-vue), all of which can be sourced from NPM or from a CDN. +Phosphor is available for [web](https://github.com/phosphor-icons/web), [React](https://github.com/phosphor-icons/react), [Vue](https://github.com/phosphor-icons/vue), [Flutter](https://github.com/phosphor-icons/flutter), [Elm](https://github.com/phosphor-icons/phosphor-elm), and other frameworks and platforms. -### HTML/CSS +### Vanilla Web - **Simple to use** – We use a similar approach as many other icon sets out there, providing icons as a webfont that uses Unicode's Private Use Area character codes to map normally non-rendering characters to icons. But you don't need to know that. All you need to do is add the script to the document ``, and drop in icons with an `` tag and the appropriate class: @@ -23,26 +23,26 @@ Phosphor is available as a [one-liner](https://github.com/phosphor-icons/phospho - + - - + + ``` -Check out the full documentation on the [phosphor-icons](https://github.com/phosphor-icons/phosphor-icons) repo page. +Check out the full documentation on the [@phosphor-icons/web](https://github.com/phosphor-icons/web) repo page. ### React -- **Powerful** – Phosphor's intuitive but powerful API can style the `color`, `size`, and `weight` of an icon with a few keystrokes, provide default styles to all icons via the Context API, or directly manipulate the SVG at runtime through render props to do some amazing things! Check out the full documentation on the [phosphor-react](https://github.com/phosphor-icons/phosphor-react) repo page. +- **Powerful** – Phosphor's intuitive but powerful API can style the `color`, `size`, and `weight` of an icon with a few keystrokes, provide default styles to all icons via the Context API, or directly manipulate the SVG at runtime through render props to do some amazing things! Check out the full documentation on the [@phosphor-icons/react](https://github.com/phosphor-icons/react) repo page. ```jsx import React from "react"; import ReactDOM from "react-dom"; -import { Smiley, Heart, Horse } from "phosphor-react"; +import { Smiley, Heart, Horse } from "@phosphor-icons/react"; const App = () => { return ( @@ -62,7 +62,7 @@ ReactDOM.render(, document.getElementById("root")); ### Vue -- **Parity** – As with React, you can manipulate the `color`, `size`, and `weight` of an icon with a few keystrokes, or provide default styles to all icons via the `provide/inject` API. It is fully tree-shakable and ready to use right away. Check out the full documentation on the [phosphor-vue](https://github.com/phosphor-icons/phosphor-vue) repo page. +- **Parity** – As with React, you can manipulate the `color`, `size`, and `weight` of an icon with a few keystrokes, or provide default styles to all icons via the `provide/inject` API. It is fully tree-shakable and ready to use right away. Check out the full documentation on the [@phosphor-icons/vue](https://github.com/phosphor-icons/vue) repo page. ```html