From 1b9fc17423757a9707c9879733e213833fe7fc83 Mon Sep 17 00:00:00 2001 From: Jonathan Reinink Date: Fri, 22 Mar 2024 16:07:06 -0400 Subject: [PATCH] Improve project READMEs (#1152) * Improve project READMEs * Update shields * Update changelog --- CHANGELOG.md | 2 +- README.md | 13 +++++----- react/.gitignore | 1 + react/README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++ react/package.json | 3 ++- vue/.gitignore | 1 + vue/README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++ vue/package.json | 3 ++- 8 files changed, 131 insertions(+), 10 deletions(-) create mode 100644 react/README.md create mode 100644 vue/README.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 94fa1c00..aa3bfe57 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -- Nothing yet! +- Improve project READMEs ([#1152](https://github.com/tailwindlabs/heroicons/pull/1152)) ## [2.1.2] - 2024-03-22 diff --git a/README.md b/README.md index b1e83148..7a1bb831 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@

- - Heroicons - - - Heroicons + + + + + Heroicons +

@@ -73,8 +74,6 @@ Icons use an upper camel case naming convention and are always suffixed with the ## Vue -_Note that this library currently only supports Vue 3._ - First, install `@heroicons/vue` from npm: ```sh diff --git a/react/.gitignore b/react/.gitignore index cbeb9c39..161f6059 100644 --- a/react/.gitignore +++ b/react/.gitignore @@ -5,3 +5,4 @@ !outline !solid !LICENSE +!README.md diff --git a/react/README.md b/react/README.md new file mode 100644 index 00000000..986068bd --- /dev/null +++ b/react/README.md @@ -0,0 +1,59 @@ +

+ + + + + Heroicons + + +

+ +

Beautiful hand-crafted SVG icons, by the makers of Tailwind CSS.

+ +

+ Browse at Heroicons.com → +

+ +

+ Latest Release + License +

+ +## Basic Usage + +First, install `@heroicons/react` from npm: + +```sh +npm install @heroicons/react +``` + +Now each icon can be imported individually as a React component: + +```js +import { BeakerIcon } from '@heroicons/react/24/solid' + +function MyComponent() { + return ( +
+ +

...

+
+ ) +} +``` + +The 24x24 outline icons can be imported from `@heroicons/react/24/outline`, the 24x24 solid icons can be imported from `@heroicons/react/24/solid`, the 20x20 solid icons can be imported from `@heroicons/react/20/solid`, and 16x16 solid icons can be imported from `@heroicons/react/16/solid`. + +Icons use an upper camel case naming convention and are always suffixed with the word `Icon`. + +[Browse the full list of icon names on UNPKG →](https://unpkg.com/browse/@heroicons/react/24/outline/) + +## Contributing + +While we absolutely appreciate anyone's willingness to try and improve the project, we're currently only interested in contributions that fix bugs, for example things like incorrect TypeScript types, or fixing an icon that's been exported with a fill instead of a stroke, etc. + +**We're not accepting contributions for new icons or adding support for other frameworks like Svelte or SolidJS**. Instead we encourage you to release your own icons in your own library, and create your own packages for any other frameworks you'd like to see supported. + +## License + +This library is MIT licensed. diff --git a/react/package.json b/react/package.json index 4cecd646..9b17e4e1 100644 --- a/react/package.json +++ b/react/package.json @@ -17,7 +17,8 @@ "solid", "index.esm.js", "index.js", - "LICENSE" + "LICENSE", + "README.md" ], "sideEffects": false, "exports": { diff --git a/vue/.gitignore b/vue/.gitignore index cbeb9c39..161f6059 100644 --- a/vue/.gitignore +++ b/vue/.gitignore @@ -5,3 +5,4 @@ !outline !solid !LICENSE +!README.md diff --git a/vue/README.md b/vue/README.md new file mode 100644 index 00000000..103e8ce0 --- /dev/null +++ b/vue/README.md @@ -0,0 +1,59 @@ +

+ + + + + Heroicons + + +

+ +

Beautiful hand-crafted SVG icons, by the makers of Tailwind CSS.

+ +

+ Browse at Heroicons.com → +

+ +

+ Latest Release + License +

+ +## Basic Usage + +First, install `@heroicons/vue` from npm: + +```sh +npm install @heroicons/vue +``` + +Now each icon can be imported individually as a Vue component: + +```vue + + + +``` + +The 24x24 outline icons can be imported from `@heroicons/vue/24/outline`, the 24x24 solid icons can be imported from `@heroicons/vue/24/solid`, the 20x20 solid icons can be imported from `@heroicons/vue/20/solid`, and the 16x16 solid icons can be imported from `@heroicons/vue/16/solid`. + +Icons use an upper camel case naming convention and are always suffixed with the word `Icon`. + +[Browse the full list of icon names on UNPKG →](https://unpkg.com/browse/@heroicons/vue/24/outline/) + +## Contributing + +While we absolutely appreciate anyone's willingness to try and improve the project, we're currently only interested in contributions that fix bugs, for example things like incorrect TypeScript types, or fixing an icon that's been exported with a fill instead of a stroke, etc. + +**We're not accepting contributions for new icons or adding support for other frameworks like Svelte or SolidJS**. Instead we encourage you to release your own icons in your own library, and create your own packages for any other frameworks you'd like to see supported. + +## License + +This library is MIT licensed. diff --git a/vue/package.json b/vue/package.json index 767a9dbf..f0d3d210 100644 --- a/vue/package.json +++ b/vue/package.json @@ -17,7 +17,8 @@ "solid", "index.esm.js", "index.js", - "LICENSE" + "LICENSE", + "README.md" ], "sideEffects": false, "exports": {