Skip to content

📝 docs: README.en.md の英語表現を改善 #223

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
ykudo-gp wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

📝 docs: README.en.md の英語表現を改善 #223

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
12 changes: 6 additions & 6 deletions README.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ English | **[日本語](./README.md)**
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)


This is a component library built with React.js and TypeScript.<br />
A React component library built with TypeScript.<br />
It implements [Goodpatch](https://goodpatch.com/)'s "Sparkle Design" system on top of shadcn/ui.

## Features

- 🔧 **Flexibility** ... Because it is based on shadcn/ui and compatible with the shadcn/ui registry, you can introduce components one by one. It is also published as an npm package, so you can integrate it in the way that best fits each project.
- ♿️ **Accessibility** ... Sparkle Design is engineered with accessibility as a primary consideration.
- 🎨 **Customizability** ... A dedicated CLI tool lets you apply the same customizations found in the Figma files. This makes it easy to spin up code for design systems built on Sparkle Design.
- 🔧 **Flexibility** ... Built on shadcn/ui and compatible with the shadcn/ui registry, so you can install components one at a time. Also available as an npm package for full-library integration — choose whichever approach suits your project.
- ♿️ **Accessibility** ... Built with accessibility as a first-class concern.
- 🎨 **Customizability** ... A dedicated CLI tool lets you apply the same customizations found in the Figma files. This makes it easy to scaffold projects built on Sparkle Design.
- 🤖 **AI Friendly** ... Ships with skills and guard configurations for Claude Code, Cursor, and Codex. Maintain design system quality even during AI-assisted coding.

## Usage
Expand Down Expand Up @@ -243,8 +243,8 @@ pnpm type-check

The Makefile defines the following targets:

- `registry` ... Generate the registry and copy files to the public directory
- `new-component` ... Interactive flow for creating a new component
- `registry` — Generate the registry and copy files to the public directory
- `new-component` — Interactive flow for creating a new component

Run `make help` for details.

Expand Down
Loading