@ninicons/iconify 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sayantan Roy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,58 @@
-# Temporary Holding Version
+# @ninicons/iconify
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Every Ninicon as one [Iconify](https://iconify.design) collection, prefix `nini`, for the tools that read IconifyJSON:
+Tailwind CSS and UnoCSS icon plugins, Astro Icon, Iconify's components.
+
+| Name | Style |
+|---|---|
+| `nini:rocket` (or `nini:rocket-regular`) | regular |
+| `nini:rocket-thin` `-light` `-semibold` `-bold` | the other stroke weights |
+| `nini:rocket-fill` `nini:rocket-duotone` | fill and duotone |
+
+```bash
+npm i -D @ninicons/iconify
+```
+
+## UnoCSS
+
+```js
+// uno.config.js
+import { defineConfig, presetIcons } from 'unocss';
+
+export default defineConfig({
+  presets: [presetIcons({ collections: { nini: () => import('@ninicons/iconify/icons.json').then((m) => m.default) } })],
+});
+```
+
+```html
+<span class="i-nini-rocket"></span>
+<span class="i-nini-rocket-bold text-2xl text-orange-600"></span>
+```
+
+## Tailwind CSS 4
+
+The plugin reads a collection by file path, from the folder Tailwind runs in:
+
+```css
+@import 'tailwindcss';
+@plugin '@iconify/tailwind4' {
+  icon-sets: from-json(nini, './node_modules/@ninicons/iconify/dist/icons.json');
+}
+```
+
+```html
+<span class="icon-[nini--rocket]"></span>
+<span class="icon-[nini--rocket-bold] text-2xl text-orange-600"></span>
+```
+
+Only the icons a page uses are generated.
+
+## Anything else
+
+```js
+import { icons } from '@ninicons/iconify'; // IconifyJSON
+```
+
+The package also carries `info.json` and `metadata.json` (categories), like Iconify's own `@iconify-json/*` sets.
+
+MIT licensed.