@ninicons/font 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,29 @@
-# Temporary Holding Version
+# @ninicons/font
 
-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 an icon font: seven fonts, one per style, and one stylesheet.
+
+```bash
+npm i @ninicons/font
+```
+
+```js
+import '@ninicons/font'; // or <link rel="stylesheet" href="…/@ninicons/font/dist/nini.css">
+```
+
+```html
+<i class="nini nini-rocket"></i>
+<i class="nini-bold nini-rocket"></i>
+<i class="nini-duotone nini-rocket" style="color: #d4502a"></i>
+```
+
+The first class picks the style: `nini` (regular), `nini-thin`, `nini-light`, `nini-semibold`, `nini-bold`,
+`nini-fill` or `nini-duotone`. The second picks the icon. Icons take the text's `font-size` and `color`. Only the
+fonts a page uses are downloaded; to ship one style alone, use `nini-<style>.css` in place of `nini.css`.
+
+A font fills shapes, so every stroke is outlined at its style's stroke width when the fonts are built. Prefer the
+SVG packages where you can; the font is for places that only take text.
+
+Codepoints live in the Private Use Area (`codepoints.json`) and never change once an icon has one. Duotone's tint is
+a second glyph per icon, drawn under the line glyph by the stylesheet. The `.otf` files are there for design apps.
+
+MIT licensed.