Skip to content

docs: add Overview section to README #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs: add Overview section to README #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ab2626
Initial plan
Copilot Feb 21, 2026
e920bc5
docs: add Overview section to README explaining what FluxMedia is
Copilot Feb 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,19 @@

A unified, TypeScript-first media library for modern applications. Upload to Cloudinary, S3, R2, and more with a single interface.

## Overview

FluxMedia is a **monorepo** that provides a single, consistent API for media uploads across multiple cloud storage and CDN providers. Instead of writing provider-specific integration code for Cloudinary, AWS S3, or Cloudflare R2, you configure one `MediaUploader` instance and your upload logic stays the same no matter which backend you use.

The monorepo is organized into focused packages:

- **`@fluxmedia/core`** – the provider-agnostic `MediaUploader` class, shared TypeScript types, error codes, file-type detection utilities, and the plugin interface.
- **`@fluxmedia/cloudinary`**, **`@fluxmedia/s3`**, **`@fluxmedia/r2`** – thin provider adapters that translate the unified API into provider-specific SDK calls.
- **`@fluxmedia/plugins`** – optional, composable plugins (validation, image optimization, metadata extraction, analytics, retry).
- **`@fluxmedia/react`** – React hooks (`useMediaUpload`) and ready-to-use components built on top of the core library.

Typical use cases include profile-picture uploads, document management, video hosting pipelines, and any scenario where you need reliable, type-safe file uploads without locking yourself into a single cloud provider.

## Features

- **Unified API** - Write once, use any provider
Expand Down