-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: move README.md to packages/wedges
- Loading branch information
1 parent
1e758c6
commit c5592cb
Showing
2 changed files
with
63 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1 @@ | ||
| <p align="center"> | ||
| <a href="https://lemonsqueezy.com/wedges"> | ||
| <img width="100%" src="https://github.com/lmsqueezy/wedges/blob/c47d43f8c76271381e812a357628fe3d3b076f25/apps/docs/public/images/banner.webp" alt="Wedges UI library" /> | ||
| </a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://lemonsqueezy.com/wedges/docs"><strong>Get Started with Wedges →</strong></a> | ||
| </p> | ||
|
|
||
| # Wedges | ||
|
|
||
| Wedges is an ever-expanding, open-source React UI library built with the Wedges Design System, Radix primitives, and Tailwind CSS. | ||
|
|
||
| With Wedges, you get a range of pre-built, customizable components that are easy to use and integrate into your React projects. It also comes with full TypeScript support, ensuring type safety and developer-friendly experience. | ||
|
|
||
| ## License | ||
|
|
||
| Wedges is licensed under the [MIT License](./LICENSE). | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Visit <a href="https://www.lemonsqueezy.com/wedges/docs" target="_blank">Wedges Docs</a> to get started. | ||
|
|
||
| ## Repository Structure | ||
|
|
||
| This repository is organized as a monorepo (Turborepo) and is managed with <a href="https://pnpm.io" target="_blank">PNPM</a>. | ||
|
|
||
| ## Packages | ||
|
|
||
| - [packages/wedges](./packages/wedges) - This is the heart of our project – the UI library itself. Here you'll find all the components, utilities, and core functionality of the Wedges UI library. | ||
|
|
||
| - [packages/eslint-config](./packages/eslint-config/) - This package contains the ESLint configuration used by packages and apps in this monorepo. | ||
|
|
||
| ## Apps | ||
|
|
||
| - [apps/docs](./apps/docs) - Contains the Next.js documentation site for the Wedges UI library. This is where we maintain the documentation, examples, and guides for using the library. | ||
|
|
||
| ## Development | ||
|
|
||
| 1. Clone the monorepo. | ||
| 2. Install the necessary dependencies using PNPM: | ||
|
|
||
| ```bash | ||
| pnpm i --hoist | ||
| ``` | ||
|
|
||
| To start the development server, run: | ||
|
|
||
| ```bash | ||
| pnpm dev | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| Any contributions you make are greatly appreciated. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". | ||
|
|
||
| Please refer to the [CONTRIBUTING](./CONTRIBUTING.md) for more information. | ||
|
|
||
| ## Connect with us | ||
|
|
||
| Follow us <a href="https://twitter.com/lmsqueezy/" target="_blank" rel="noreferrer">@lmsqueezy</a> for the latest and coolest. Let us know what you're building with Wedges! | ||
| packages/wedges/README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| <p align="center"> | ||
| <a href="https://lemonsqueezy.com/wedges"> | ||
| <img width="100%" src="https://github.com/lmsqueezy/wedges/blob/c47d43f8c76271381e812a357628fe3d3b076f25/apps/docs/public/images/banner.webp" alt="Wedges UI library" /> | ||
| </a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://lemonsqueezy.com/wedges/docs"><strong>Get Started with Wedges →</strong></a> | ||
| </p> | ||
|
|
||
| # Wedges | ||
|
|
||
| Wedges is an ever-expanding, open-source React UI library built with the Wedges Design System, Radix primitives, and Tailwind CSS. | ||
|
|
||
| With Wedges, you get a range of pre-built, customizable components that are easy to use and integrate into your React projects. It also comes with full TypeScript support, ensuring type safety and developer-friendly experience. | ||
|
|
||
| ## License | ||
|
|
||
| Wedges is licensed under the [MIT License](./LICENSE). | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Visit <a href="https://www.lemonsqueezy.com/wedges/docs" target="_blank">Wedges Docs</a> to get started. | ||
|
|
||
| ## Repository Structure | ||
|
|
||
| This repository is organized as a monorepo (Turborepo) and is managed with <a href="https://pnpm.io" target="_blank">PNPM</a>. | ||
|
|
||
| ## Packages | ||
|
|
||
| - [packages/wedges](./packages/wedges) - This is the heart of our project – the UI library itself. Here you'll find all the components, utilities, and core functionality of the Wedges UI library. | ||
|
|
||
| - [packages/eslint-config](./packages/eslint-config/) - This package contains the ESLint configuration used by packages and apps in this monorepo. | ||
|
|
||
| ## Apps | ||
|
|
||
| - [apps/docs](./apps/docs) - Contains the Next.js documentation site for the Wedges UI library. This is where we maintain the documentation, examples, and guides for using the library. | ||
|
|
||
| ## Development | ||
|
|
||
| 1. Clone the monorepo. | ||
| 2. Install the necessary dependencies using PNPM: | ||
|
|
||
| ```bash | ||
| pnpm i --hoist | ||
| ``` | ||
|
|
||
| To start the development server, run: | ||
|
|
||
| ```bash | ||
| pnpm dev | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| Any contributions you make are greatly appreciated. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". | ||
|
|
||
| Please refer to the [CONTRIBUTING](./CONTRIBUTING.md) for more information. | ||
|
|
||
| ## Connect with us | ||
|
|
||
| Follow us <a href="https://twitter.com/lmsqueezy/" target="_blank" rel="noreferrer">@lmsqueezy</a> for the latest and coolest. Let us know what you're building with Wedges! |