Introduction
Welcome to the @avatar-generator documentation! This library enables developers to create customizable avatar components for use in web applications. It is designed to be framework-agnostic, with support for multiple frontend frameworks such as React and Angular.
Why Choose @avatar-generator?
- Multi-Framework Support: Provides seamless integration with React, Angular, and more.
- Customizable: Adjust colors, shapes, sizes, and text to match your application’s design.
- Core Package: Shared logic in the
@avatar-generator/core
package ensures consistency across frameworks. - Lightweight: Minimal dependencies for fast and efficient avatar generation.
Features
-
🎨 Customizable Appearance
Personalize avatars with options for size, colors, shapes, and text. -
🌐 Cross-Framework Compatibility
Use the same logic across different frameworks like React and Angular. -
⚡ Easy to Integrate
Simple APIs and props make it quick to add avatars to your project. -
🛠️ Open Source
Freely available under an open-source license for community contributions and use.
Getting Started
Follow the Installation Guide to learn how to set up the library for your project. Once installed, check out the framework-specific guides for React and Angular to start creating avatars.
Need help? Visit our GitHub repository for more information, bug reports, and contributions.