From 375d9ac2a1e8dc2c07ae58b2b370105de350115c Mon Sep 17 00:00:00 2001 From: Sarmaged Date: Wed, 19 Jun 2024 02:40:33 +0300 Subject: [PATCH] Update README.md --- README.md | 63 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index ceb57e1..4eb2d7a 100644 --- a/README.md +++ b/README.md @@ -6,70 +6,11 @@ ![license](https://img.shields.io/npm/l/style-forge.base) ![build](https://github.com/Sarmaged/style-forge.base/actions/workflows/publish.yml/badge.svg) -## Description - `Style-Forge.Base` provides the foundational CSS variables and base styles for the Style Forge framework. It includes essential typography, color schemes, and utility classes, ensuring a consistent and customizable design system for your web projects. -## Installation - -You can install the package via npm or yarn: - -```bash -npm install style-forge.base -``` - -```bash -yarn add style-forge.base -``` - -## Usage - -After installation, you can import the CSS file into your project: - -```css -@import "style-forge.base"; -``` - -Or, if you are using Webpack or another module bundler: - -```js -import 'style-forge.base'; -``` - -## Variables - -`--sf-c` - these are colors in HSL - -```css -:root { - --sf-base-ff: system-ui, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; - --sf-base-fw: 400; - --sf-base-fz: 1rem; - --sf-base-lh: 0.8; - - --sf-h1: 3rem; - --sf-h2: 2.5rem; - --sf-h3: 2rem; - --sf-h4: 1.5rem; - --sf-h5: 1.25rem; - --sf-h6: 1rem; - - --sf-txt-small: 0.75rem; - - --sf-disabled: 0.4; /* opacity */ - - --sf-c-link: 225 73% 57%; /* - color */ - - --sf-c-mark-bg: 60 100% 50%; /* - background */ - --sf-c-mark-txt: 0 0% 10%; /* - color */ +## Description - --sf-c-txt: 0 0% 10%; /* All color */ - --sf-c-bg: 0 0% 100%; /* All background */ - --sf-c-bd: 0 0% 75%; /* All border */ - --sf-c-shape-bg: 0 0% 90%; /*
 - background */
-  --sf-c-backdrop: 0 0% 10%; /* ::backdrop */
-}
-```
+To check out docs, visit [style-forge.dev](https://style-forge.dev/base/)
 
 ## Contributing