@catalystsoftware/icons 1.0.0

package/README.md

@@ -0,0 +1,505 @@
+## Installation
+
+```bash
+npm install @catalystsoftware/icons
+# or
+pnpm add @catalystsoftware/icons
+```
+
+## Icon list
+
+Ace
+Alien
+AlignCenter
+AlignEndVertical
+AlignJustify
+AlignLeft
+AlignRight
+AppWindow
+Archive
+ArchiveX
+ArrowBadgeDown
+ArrowBadgeLeft
+ArrowBadgeRight
+ArrowBadgeUp
+ArrowBigDown
+ArrowBigLeft
+ArrowBigRight
+ArrowBigUp
+ArrowDown
+ArrowDownFromLine
+ArrowDownLeft
+ArrowDownRight
+ArrowLeft
+ArrowLeftRight
+ArrowRight
+ArrowUp
+ArrowUpDown
+ArrowUpFromLine
+ArrowUpNarrowWide
+ArrowUpRight
+Asterisk
+AtSign
+AudioWaveform
+Award
+Badge
+BadgeCheck
+Ban
+Banknote
+BarChart
+BarChartAreaBig
+Bat
+Bed
+BeggarsHand
+Bell
+Biohazard
+Blocks
+Bluetooth
+Bold
+Bookmark
+BookOpen
+BookOpenText
+Bot
+Box
+Boxes
+Braces
+BracketsAngle
+Brain
+Briefcase
+Browser
+Brush
+Bug
+Building
+Burger
+Calculator
+Calendar
+CalendarDays
+CalendarPlus
+Camera
+Capture
+Car
+CaretDown
+CaretLeft
+CaretRight
+CaretUp
+CarFront
+Check
+CheckCircle
+CheckSquare
+ChefHat
+ChevronDown
+ChevronLeft
+ChevronRight
+ChevronsDown
+ChevronsLeft
+ChevronsLeftRight
+ChevronsRight
+ChevronsUpDown
+ChevronUp
+Circle
+CircleOff
+CirclePlus
+Clipboard
+ClipboardCheck
+ClipboardData
+ClipboardText
+Clock
+Cloud
+CloudRain
+CloudUpload
+Code
+Cog
+Columns
+Columns3
+Columns4
+Command
+Compass
+Component
+Computer
+Construction
+Cookie
+Copy
+CornerUpLeft
+CornerUpRight
+Cpu
+Crown
+Dashboard
+Database
+Delete
+DeviceCode
+Dog
+DollarSign
+Dot
+Dots
+DotsVertical
+Download
+Droplets
+EPassport
+Eraser
+ExclamationPointMessageCircle
+ExclamationPointOctagon
+ExclamationPointTriangle
+Expand
+ExternalLink
+Eye
+EyeClosed
+EyeOff
+Facebook
+Figma
+File
+FileCode
+FileImage
+FileInput
+FileJson
+FileOutput
+FilePlus
+FileSpreadsheet
+FileText
+FileTypeBmp
+FileTypeCss
+FileTypeCsv
+FileTypeDoc
+FileTypeDocx
+FileTypeHtml
+FileTypeJpg
+FileTypeJs
+FileTypeJsx
+FileTypePdf
+FileTypePhp
+FileTypePng
+FileTypePpt
+FileTypeRs
+FileTypeSql
+FileTypeSvg
+FileTypeTs
+FileTypeTsx
+FileTypeTxt
+FileTypeVue
+FileTypeXls
+FileTypeXml
+FileTypeZip
+FileTypography
+FileX
+FishBone
+Flag
+Flame
+Focus
+Folder
+FolderCheck
+FolderClosed
+FolderDown
+FolderOpen
+FolderPlus
+FolderRoot
+FolderSearch
+FolderTree
+FolderUp
+Footprints
+Forward
+FourOhFour
+Funnel
+GalleryVerticalEnd
+Gamepad2
+Gauge
+Gavel
+Gem
+Ghost
+GhostFilled
+GhostFloating
+GhostFloatingFilled
+Gift
+GitBranch
+GitCommitVertical
+Github
+Gitlab
+Globe
+GlobeLock
+Golang
+GraduationCap
+Grid
+Grid3X3
+GripVertical
+H1
+H2
+H3
+H4
+H5
+H6
+Hammer
+HardDrive
+HardHat
+Heading
+Headphones
+Heart
+HeartHandshake
+Hexagon
+Home
+Html
+ICircle
+Image
+Import
+Inbox
+IndentDecrease
+IndentIncrease
+index.ts
+Instagram
+Jack
+Javascript
+Kanban
+Key
+Keyboard
+King
+Kotlin
+Laptop
+Layers
+LetterCaseLower
+LetterCaseToggle
+LetterCaseUpper
+Library
+LifeBuoy
+Lightbulb
+Link
+Linkedin
+List
+ListCheck
+ListChecks
+ListFilter
+ListFilterPlus
+ListMusic
+ListOrdered
+ListRestart
+Loader
+LoaderCircle
+Lock
+LockOpen
+LogIn
+LogOut
+Mail
+MailCheck
+Map
+MapPin
+Maximize
+Megaphone
+Menu
+MessageCircle
+MessageSquare
+MessagesSquare
+Mic
+Minimize
+Minus
+Moon
+MousePointer
+Move
+Music
+Navigation
+Newspaper
+NotebookText
+NotepadText
+Npm
+Package
+Pacman
+Paintbrush
+Palette
+PanelLeft
+PanelLeftClose
+PanelLeftOpen
+PanelRight
+Paperclip
+Pause
+Pdf
+Pen
+Pencil
+PencilCheck
+PenTool
+Percent
+Phone
+Photo
+PictureInPicture
+PieChart
+PiggyBank
+Pin
+Plane
+Play
+Plus
+Pointer
+Popcorn
+Power
+Prescription
+Printer
+PuzzlePiece
+Python
+QrCode
+Queen
+QuestionMarkCircle
+QuestionMarkMessageCircle
+Quote
+Radar
+Radio
+Redo
+RefreshCcw
+RefreshCw
+Repeat
+Reply
+ReplyAll
+Rocket
+RotateCcw
+RotateCw
+Ruler
+Rust
+Sass
+Save
+Scale
+Scan
+ScanLine
+Scissors
+Search
+SearchX
+Send
+Settings
+Share
+Shield
+Ship
+ShoppingBag
+ShoppingCart
+Sidebar
+SidebarRight
+SkipBack
+SkipForward
+Smartphone
+Smile
+SmilePlus
+SortAscending
+SortDescending
+Sparkles
+Split
+Square
+SquareSplitHorizontal
+SquareTerminal
+Star
+StarOff
+Stopwatch
+Store
+Strikethrough
+Subtitles
+Sun
+Svg
+Swift
+Table
+Tag
+Tally1
+Tally2
+Tally3
+Tally4
+Tally5
+Target
+Terminal
+Terminal2
+TextCursorInput
+TextDecrease
+TextIncrease
+TextSize
+TextWrap
+TextWrapColumn
+TextWrapDisabled
+ThumbsDown
+ThumbsUp
+Ticket
+Tilde
+Timer
+Toml
+Trash
+Trash2
+TrendingDown
+TrendingUp
+Trophy
+Truck
+Tv
+Twitter
+Type
+Typescript
+Underline
+Undo
+Upload
+User
+UserCheck
+UserCircle
+UserDown
+UserHeart
+UserMinus
+UserPlus
+Users
+UserSettings
+UsersGroup
+UserSquareRounded
+UserStar
+Utensils
+UtensilsCrossed
+Video
+VideoOff
+View360
+Visa
+VolumeDown
+VolumeOff
+VolumeUp
+VolumeX
+Walk
+Wallet
+Wallpaper
+Wand
+Waveform
+Waves
+Wifi
+Wrench
+X
+XCircle
+Youtube
+Zap
+ZoomIn
+ZoomOut
+
+## Basic Usage
+
+### Import specific icons
+
+```tsx
+import { Home, User } from '@catalyst/icons';
+
+function App() {
+  return (
+    <div>
+      <Home className="text-primary" size={24} />
+      <User className="text-gray-500" size={32} strokeWidth={1.5} />
+    </div>
+  );
+}
+```
+
+### Dynamic icon rendering
+
+```tsx
+import { Icon, icons } from '@catalyst/icons';
+
+function DynamicIcon({ iconName }: { iconName: string }) {
+  return <Icon name={iconName} icons={icons} className="text-blue-500" />;
+}
+```
+
+## Props
+
+All icons accept the following props:
+
+- `size`: number | string (default: 24) - Size of the icon
+- `color`: string (default: 'currentColor') - Stroke color
+- `strokeWidth`: number | string (default: 2) - Width of the stroke
+- `className`: string - CSS classes (works with Tailwind!)
+- All standard SVG attributes
+
+## Tailwind CSS Integration
+
+Works seamlessly with Tailwind:
+
+```tsx
+<Home className="w-6 h-6 text-blue-500 hover:text-blue-700" />
+<User className="text-primary dark:text-primary-dark" size={20} />
+```
+