Skip to content

README.md

Latest commit

 

History

History
67 lines (43 loc) · 2.02 KB

README.md

File metadata and controls

67 lines (43 loc) · 2.02 KB
Raw

Easy Mesh Gradient

Frame 2 (2)

A lightweight, zero-dependency library for generating beautiful CSS mesh gradients with TypeScript support.

Quick Links

Quick Start

npm install easy-mesh-gradient
import easyMeshGradient from "easy-mesh-gradient";

const gradient = easyMeshGradient();
document.body.style.backgroundImage = gradient;

Repository Structure

This is a Bun workspace monorepo containing:

  • lib/ — the easy-mesh-gradient npm package (documentation)
  • pages/ — the website: a landing page and a visual gradient editor with multi-format export
  • promo/ — a promo video built with Remotion

Development

# Install dependencies (all workspaces)
bun install

# Run the website dev server (bundles the library from source with HMR)
bun run dev

# Build the library
bun run build

# Build the website
bun run build:pages

# Lint and type-check
bun run lint
bun run type-check

The website aliases easy-mesh-gradient to lib/src, so library changes hot-reload in the site during development.

Releases

  • Website — deployed to GitHub Pages automatically on pushes to main that touch pages/ or the library source (workflow).
  • npm package — published automatically when a GitHub release is published (workflow). Auth uses npm trusted publishing (OIDC, no token secret) — the package on npmjs.com is configured to trust this repo's publish.yml workflow, and provenance is generated automatically. Bump lib/package.json's version before releasing.

License

MIT

Created by Steven Frady