epub-flow 0.0.1 → 0.0.3

package/README.md

@@ -1,63 +1,81 @@
-# EpubReader
+# epub-flow 📖
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.2.0.
+A premium, feature-rich EPUB reader library for Angular applications. Built with performance, aesthetics, and ease of use in mind.
 
-## Code scaffolding
+## ✨ Features
 
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+- 📖 **Smooth Reading**: Powered by Epub.js for reliable rendering.
+- 🌓 **Aesthetic Transitions**: Integrated Light and Dark modes with smooth color transitions.
+- 📚 **Beautiful TOC**: Hierarchical Table of Contents with dot leaders and indentation.
+- 🖼️ **Cover Preview**: Custom loading screen with pulse-animated book cover previews.
+- 🏷️ **Annotations**: Support for highlights, notes, and bookmarks.
+- 📱 **Responsive**: Mobile-first design that looks great on any screen size.
+- 🔍 **Search**: Full-text search with highlighting in result snippets.
+- 🛠️ **Configurable**: Toggle features like search, notes, font controls, etc.
 
-```bash
-ng generate component component-name
-```
-
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
-
-```bash
-ng generate --help
-```
-
-## Building
-
-To build the library, run:
+## 🚀 Installation
 
 ```bash
-ng build epub-reader
+npm install epub-flow ngx-editor epubjs
 ```
 
-This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
+## 🛠 Setup
 
-### Publishing the Library
+### 1. Import EpubReaderModule
 
-Once the project is built, you can publish your library by following these steps:
+Add `EpubReaderModule` to your `AppModule` or standalone component:
 
-1. Navigate to the `dist` directory:
-   ```bash
-   cd dist/epub-reader
-   ```
+```typescript
+import { EpubReaderModule } from 'epub-flow';
 
-2. Run the `npm publish` command to publish your library to the npm registry:
-   ```bash
-   npm publish
-   ```
-
-## Running unit tests
-
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
-
-```bash
-ng test
+@NgModule({
+  imports: [
+    EpubReaderModule,
+    // ... other imports
+  ]
+})
+export class AppModule { }
 ```
 
-## Running end-to-end tests
+### 2. Required Styles
+The package is designed to be standalone. You only need to ensure your global `styles.scss` is set up for your application. No external UI library styles are required.
 
-For end-to-end (e2e) testing, run:
+## 📖 Usage
 
-```bash
-ng e2e
+### Basic Usage
+```html
+<epub-flow [epubUrl]="'assets/books/sample.epub'"></epub-flow>
 ```
 
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
-
-## Additional Resources
+### Advanced Usage with Feature Toggles
+```html
+<epub-flow 
+  [epubBlob]="currentBlob" 
+  [coverPage]="'assets/cover.jpg'"
+  [enableDarkMode]="true"
+  [enableSearch]="true"
+  [enableHighlights]="true"
+  [enableBookmarks]="true"
+  [enableChapterList]="true"
+  [enableTextSelection]="true">
+</epub-flow>
+```
 
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+## ⚙️ Configuration (Inputs)
+
+| Input | Type | Default | Description |
+|---|---|---|---|
+| `epubUrl` | `string` | `null` | URL to a remote EPUB file. |
+| `epubBlob` | `Blob` | `null` | Local Blob or File object for direct loading. |
+| `coverPage` | `string` | `null` | URL to a cover image displayed during loading. |
+| `bookId` | `string \| number` | `0` | Unique ID for backend integration. |
+| `enableDarkMode` | `boolean` | `true` | Toggle Dark Mode availability. |
+| `enableSearch` | `boolean` | `true` | Toggle Search tool. |
+| `enableHighlights` | `boolean` | `true` | Toggle Highlighting tools. |
+| `enableBookmarks` | `boolean` | `true` | Toggle Bookmarking. |
+| `enableChapterList` | `boolean` | `true` | Toggle Table of Contents. |
+| `enableFontSize` | `boolean` | `true` | Toggle Font size controls. |
+| `enableNotes` | `boolean` | `true` | Toggle Note creation. |
+
+## 📄 License
+MIT