mirror of
https://github.com/hanskokx/arcane_framework.git
synced 2026-05-14 02:19:08 +02:00
Added additional documentation and removed Logger dependency
Signed-off-by: Hans Kokx <hans.d.kokx@gmail.com>
This commit is contained in:
@@ -1,3 +1,40 @@
|
||||
/// The Arcane Framework is a comprehensive Dart package designed to provide a
|
||||
/// scalable architecture for managing essential application services such as
|
||||
/// logging, authentication, theming, feature flags, and more.
|
||||
///
|
||||
/// The framework offers a centralized way to access and manage these services,
|
||||
/// making it easy to build dynamic and feature-rich applications. It includes
|
||||
/// a robust logging system, dynamic feature toggles, theming capabilities, and
|
||||
/// user authentication handling.
|
||||
///
|
||||
/// ## Key Features:
|
||||
/// - **Service Management**: Centralized access to critical services like
|
||||
/// logging, feature flags, and theming.
|
||||
/// - **Feature Flags**: Dynamically enable or disable features using
|
||||
/// `ArcaneFeatureFlags`.
|
||||
/// - **Logging**: Flexible logging with different severity levels
|
||||
/// (`debug`, `info`, `error`, etc.).
|
||||
/// - **Theming**: Easy light/dark mode switching with `ArcaneReactiveTheme`.
|
||||
/// - **Authentication**: Manage user login, sign up, and token-based
|
||||
/// authentication.
|
||||
///
|
||||
/// Example usage:
|
||||
/// ```dart
|
||||
/// import 'package:arcane_framework/arcane_framework.dart';
|
||||
///
|
||||
/// void main() {
|
||||
/// runApp(
|
||||
/// ArcaneApp(
|
||||
/// services: [MyArcaneService.I],
|
||||
/// child: MyApp(),
|
||||
/// ),
|
||||
/// );
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// This library is designed to simplify the development of complex, scalable
|
||||
/// Flutter applications by offering a set of tools to manage core
|
||||
/// functionalities efficiently.
|
||||
library arcane_framework;
|
||||
|
||||
export "package:arcane_framework/src/arcane.dart";
|
||||
|
||||
Reference in New Issue
Block a user