From 9450c66b582ed1fc3a1ead69f18e18bece2ddbbd Mon Sep 17 00:00:00 2001 From: Cole Peters Date: Tue, 27 Feb 2024 12:44:34 -0600 Subject: [PATCH] Clarify customization and standalone usage --- README.md | 56 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 36 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 4efe83d..bc0763f 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,13 @@ # enhance-styles Single responsibility CSS classes — optimized for [Enhance](https://enhance.dev) and the web at large. -## Install -```shell -git clone https://github.com/enhance-dev/enhance-styles.git -``` - -## Standalone usage - -See [the customization instructions](#customize) for a reference to which aspects of Enhance Styles can be adjusted to your liking. - -After writing your preferred `config.json` options, write the generated styles to `dist/enhance.css`: - -```shell -npm run build -``` +## Usage in Enhance apps -Minify `dist/enhance.css` to `dist/enhance.min.css`: +All new Enhance projects come preloaded with Enhance Styles; no installation is required. -```shell -npm run prod -``` +To customize Enhance Styles within your Enhance application, see [the Customize section](#customize). -Copy `enhance.css` or `enhance.min.css` to your project and either reference it with the `` element, or inline it in a `