Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sarmaged committed Jun 19, 2024
1 parent cb0a222 commit 84d969d
Showing 1 changed file with 2 additions and 40 deletions.
42 changes: 2 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,49 +6,11 @@
![license](https://img.shields.io/npm/l/style-forge.themes)
![build](https://github.com/Sarmaged/style-forge.themes/actions/workflows/publish.yml/badge.svg)

## Description

`Style-Forge.Themes` package is a powerful and flexible tool designed for managing and applying themes to your web applications. It provides a streamlined way to handle theme customization, allowing developers to create, switch, and maintain multiple themes effortlessly.

## Installation

You can install the package via npm or yarn:

```bash
npm install style-forge.themes
```

```bash
yarn add style-forge.themes
```

## Usage

After installation, you can import the CSS file into your project:

```css
@import "style-forge.themes";
```

Or, if you are using Webpack or another module bundler:

```js
import 'style-forge.themes';
```

⚠️ Skip this if you don't need to specify a color scheme. The default will always be a light theme.

There are three standard modes `dark / light / auto (system)`

`auto` - this is the system color theme selection
## Description

```html
<html ... data-theme="auto">
or
<html ... data-theme="dark">
or
<html ... data-theme="light">
```
To check out docs, visit [style-forge.dev](https://style-forge.dev/themes/)

## Contributing

Expand Down

0 comments on commit 84d969d

Please sign in to comment.