Improve project READMEs (#1152)

* Improve project READMEs

* Update shields

* Update changelog

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
 

README.md

@@ -1,9 +1,10 @@
 <p align="center">
-  <a href="https://heroicons.com/#gh-light-mode-only" target="_blank">
-    <img src="./.github/logo-light.svg" alt="Heroicons" width="300">
-  </a>
-  <a href="https://heroicons.com/#gh-dark-mode-only" target="_blank">
-    <img src="./.github/logo-dark.svg" alt="Heroicons" width="300">
+  <a href="https://heroicons.com" target="_blank">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/tailwindlabs/heroicons/HEAD/.github/logo-dark.svg">
+      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/tailwindlabs/heroicons/HEAD/.github/logo-light.svg">
+      <img alt="Heroicons" width="315" height="117" style="max-width: 100%" src="https://raw.githubusercontent.com/tailwindlabs/heroicons/HEAD/.github/logo-light.svg">
+    </picture>
   </a>
 </p>
 
@@ -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

react/.gitignore

@@ -5,3 +5,4 @@
 !outline
 !solid
 !LICENSE
+!README.md

react/README.md

@@ -0,0 +1,59 @@
+<p align="center">
+  <a href="https://heroicons.com" target="_blank">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/tailwindlabs/heroicons/HEAD/.github/logo-dark.svg">
+      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/tailwindlabs/heroicons/HEAD/.github/logo-light.svg">
+      <img alt="Heroicons" width="315" height="117" style="max-width: 100%" src="https://raw.githubusercontent.com/tailwindlabs/heroicons/HEAD/.github/logo-light.svg">
+    </picture>
+  </a>
+</p>
+
+<p align="center">Beautiful hand-crafted SVG icons, by the makers of Tailwind CSS.<p>
+
+<p align="center">
+  <a href="https://heroicons.com"><strong>Browse at Heroicons.com &rarr;</strong></a>
+</p>
+
+<p align="center">
+    <a href="https://github.com/tailwindlabs/heroicons/releases"><img src="https://img.shields.io/npm/v/@heroicons/react" alt="Latest Release"></a>
+    <a href="https://github.com/tailwindlabs/heroicons/blob/master/react/LICENSE"><img src="https://img.shields.io/npm/l/@heroicons/react.svg" alt="License"></a>
+</p>
+
+## 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 (
+    <div>
+      <BeakerIcon className="h-6 w-6 text-blue-500" />
+      <p>...</p>
+    </div>
+  )
+}
+```
+
+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 &rarr;](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.

react/package.json

@@ -17,7 +17,8 @@
     "solid",
     "index.esm.js",
     "index.js",
-    "LICENSE"
+    "LICENSE",
+    "README.md"
   ],
   "sideEffects": false,
   "exports": {

vue/.gitignore

@@ -5,3 +5,4 @@
 !outline
 !solid
 !LICENSE
+!README.md

vue/README.md

@@ -0,0 +1,59 @@
+<p align="center">
+  <a href="https://heroicons.com" target="_blank">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/tailwindlabs/heroicons/HEAD/.github/logo-dark.svg">
+      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/tailwindlabs/heroicons/HEAD/.github/logo-light.svg">
+      <img alt="Heroicons" width="315" height="117" style="max-width: 100%" src="https://raw.githubusercontent.com/tailwindlabs/heroicons/HEAD/.github/logo-light.svg">
+    </picture>
+  </a>
+</p>
+
+<p align="center">Beautiful hand-crafted SVG icons, by the makers of Tailwind CSS.<p>
+
+<p align="center">
+  <a href="https://heroicons.com"><strong>Browse at Heroicons.com &rarr;</strong></a>
+</p>
+
+<p align="center">
+    <a href="https://github.com/tailwindlabs/heroicons/releases"><img src="https://img.shields.io/npm/v/@heroicons/vue" alt="Latest Release"></a>
+    <a href="https://github.com/tailwindlabs/heroicons/blob/master/vue/LICENSE"><img src="https://img.shields.io/npm/l/@heroicons/vue.svg" alt="License"></a>
+</p>
+
+## 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
+<template>
+  <div>
+    <BeakerIcon class="h-6 w-6 text-blue-500" />
+    <p>...</p>
+  </div>
+</template>
+
+<script setup>
+import { BeakerIcon } from '@heroicons/vue/24/solid'
+</script>
+```
+
+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 &rarr;](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.

vue/package.json

@@ -17,7 +17,8 @@
     "solid",
     "index.esm.js",
     "index.js",
-    "LICENSE"
+    "LICENSE",
+    "README.md"
   ],
   "sideEffects": false,
   "exports": {