@ninicons/core 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,30 @@
-# Temporary Holding Version
+# @ninicons/core
 
-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 a plain SVG file, in seven styles:
+
+| Style | Path |
+|---|---|
+| thin, light, regular, semibold, bold | `svg/<style>/<name>.svg` (stroke width 0.5 / 1.5 / 2 / 2.5 / 3) |
+| fill | `svg/fill/<name>.svg` |
+| duotone | `svg/duotone/<name>.svg` (a 20% tint behind the regular drawing) |
+
+Every file draws in `currentColor` on a 32-unit grid and uses no masks or ids, so icons can be inlined any number
+of times on one page.
+
+Each style is also one sprite, `sprite/<style>.svg`, with every icon as `<symbol id="nini-<name>">`:
+
+```html
+<svg width="24" height="24"><use href="/sprite/regular.svg#nini-rocket"/></svg>
+```
+
+`icons.json` lists the styles, the categories and every icon's name and category.
+
+```bash
+npm i @ninicons/core
+```
+
+```js
+import rocket from '@ninicons/core/svg/regular/rocket.svg';
+```
+
+MIT licensed.