trinil-react 1.0.1 → 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Trinil Contributors
+
+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,8 +1,6 @@
 # trinil-react
 
-React 16.8+ icon components from the Trinil icon library. Tree-shakeable, zero dependencies, 765 beautifully designed outline icons.
-
-**Now available on npm!** → https://www.npmjs.com/package/trinil-react
+React 16.8+ icon components. Tree-shakeable, zero dependencies, 765 outline icons with locked stroke styles.
 
 ## Installation
 
@@ -28,23 +26,21 @@ export function App() {
 
 ## Props
 
-All icon components accept:
-
 | Prop | Type | Default | Description |
 |------|------|---------|-------------|
 | `size` | `number` | `24` | Width/height in pixels |
-| `color` | `string` | `"currentColor"` | Stroke color |
-| `className` | `string` | - | CSS classes |
-| `title` | `string` | - | SVG `<title>` (accessibility) |
-| `ariaLabel` | `string` | - | `aria-label` attribute |
+| `color` | `string` | `"currentColor"` | Stroke color (inherits from CSS) |
+| `className` | `string` | — | CSS classes |
+| `title` | `string` | — | SVG `<title>` (accessibility) |
+| `ariaLabel` | `string` | — | `aria-label` attribute |
 
 ## Styling
 
-Icons inherit color from CSS:
+Inherit color from CSS:
 
 ```tsx
 <div style={{ color: 'blue' }}>
-  <ArrowDown /> {/* Renders in blue */}
+  <ArrowDown /> {/* Blue */}
 </div>
 ```
 
@@ -54,34 +50,19 @@ Or set directly:
 <ArrowDown color="#ff5733" size={40} className="my-icon" />
 ```
 
-## Design
-
-⚠️ **Stroke properties are locked** (stroke-width, stroke-linecap, stroke-linejoin). This ensures visual consistency.
-
-Only `size`, `color`, `className`, `title`, and `ariaLabel` can be customized.
-
 ## Accessibility
 
-Always provide `ariaLabel` or `title` for standalone icons:
+Add `ariaLabel` or `title` for standalone icons:
 
 ```tsx
 <button>
   <ArrowDown ariaLabel="Scroll down" />
 </button>
-
-<ArrowDown title="Download" />
 ```
 
-## All Available Icons
-
-765 icons including:
-- Navigation: ArrowDown, ArrowUp, ChevronLeft, etc.
-- UI: Check, Cross, AlertCircle, etc.
-- Media: Play, Pause, Volume, etc.
-- Social: Heart, Share, etc.
-- And many more...
+## Note
 
-See the repository for a complete list.
+Stroke properties (`stroke-width`, `stroke-linecap`, `stroke-linejoin`) are **locked** to ensure visual consistency. Only `size`, `color`, `className`, `title`, and `ariaLabel` are customizable.
 
 ## License