Skip to content

feat: update README to include monorepo package structure and descrip… #5

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

Merged
rjvim merged 1 commit into from
Feb 13, 2025
Merged

feat: update README to include monorepo package structure and descrip… #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ This repo has been built with two intentions:
- To help you get started building component libraries with ease
- To demonstrate how to build a component library starter

## Packages

This repo is structured as a monorepo with following packages:

- apps/docs: Docusaurus site for documentation
- packages/elements: React component library using Vite and Tailwind CSS
- packages/elements-tw-v4: React component library using Vite and Tailwind CSS V4

## Features

1. **Tree Shaking**: Built with [Vite's lib mode](https://vite.dev/) - Eliminates unused code during build process, reducing bundle sizes for better performance.
Expand Down