@central-icons-react/round-outlined-radius-2-stroke-2 0.0.33 → 0.0.36

package/README.md

@@ -4,6 +4,7 @@ A collection of round outline React icons with 2px radius and 2px stroke width,
 
 ## Table of Contents
 
+- [Quick Start](#quick-start)
 - [Installation](#installation)
 - [Requirements](#requirements)
 - [Usage](#usage)
@@ -14,6 +15,24 @@ A collection of round outline React icons with 2px radius and 2px stroke width,
 - [License](#license)
 - [Troubleshooting](#troubleshooting)
 
+## Quick Start
+
+```bash
+# Set your license key first
+export CENTRAL_LICENSE_KEY=your_license_key
+
+# Install with alias 'central-icons'
+npm install central-icons@npm:@central-icons-react/round-outlined-radius-2-stroke-2
+```
+
+```jsx
+import { IconHome } from "central-icons/IconHome";
+
+function MyComponent() {
+  return <IconHome />;
+}
+```
+
 ## Installation
 
 This package is private and can be installed via your organization's private npm registry. Make sure you have the required license key set up before installation.
@@ -37,7 +56,9 @@ pnpm add @central-icons-react/round-outlined-radius-2-stroke-2
 
 ## Usage
 
-Icons can be imported individually to keep your bundle size minimal (recommended):
+### Individual Imports (Recommended)
+
+Icons can be imported individually to keep your bundle size minimal:
 
 ```jsx
 import { IconHome } from "@central-icons-react/round-outlined-radius-2-stroke-2/IconHome";
@@ -47,26 +68,30 @@ function MyComponent() {
 }
 ```
 
-Or you can import from the main entry point (not recommended to be used in production, loads all icons):
+### Import alias
+
+If you want to have a bit cleaner imports (and you are just using one icon type), you can use import aliases
+(Requires npm at least v6.9.0 or yarn)
+
+`npm install central-icons@npm:@central-icons-react/round-outlined-radius-2-stroke-2`
 
 ```jsx
-import { CentralIcon } from "@central-icons-react/round-outlined-radius-2-stroke-2";
+import { IconHome } from "central-icons/IconHome";
 
 function MyComponent() {
-  return <CentralIcon name="IconName" />;
+  return <IconHome />;
 }
 ```
 
-If you want to have a bit cleaner imports (and you are just using one icon type), you can use import aliases
-(Requires npm at least v6.9.0 or yarn)
+### Central Icon Component
 
-`npm install central-icons@npm:@central-icons-react/round-outlined-radius-2-stroke-2`
+Or you can import from the main entry point (not recommended to be used in production, loads all icons):
 
 ```jsx
-import { IconHome } from "central-icons/IconHome";
+import { CentralIcon } from "@central-icons-react/round-outlined-radius-2-stroke-2";
 
 function MyComponent() {
-  return <IconHome />;
+  return <CentralIcon name="IconName" />;
 }
 ```