Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
1aron committed Jun 16, 2024
1 parent 29f1287 commit a295594
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 29 deletions.
27 changes: 3 additions & 24 deletions packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,39 +68,18 @@
</div>

## Documentation
Visit [css.master.co/docs/colors](https://rc.css.master.co/docs/colors) to preview the all colors.
Visit [Colors - Master CSS](https://rc.css.master.co/reference/colors) to view all colors.

## Getting Started
Install the Master Colors v2 via package managers:
Install the Master Colors via package managers:
```bash
npm install @master/colors
```
Import the colors:
```js
import colors from '@master/colors'
```
The `colors` object contains hue colors on a scale of `5~95` and [Master CSS color variables](https://rc.css.master.co/docs/colors#add-colors-by-theme):
```js
{
blue: {
5: '#e5f3fe',
10: '#dbf2fe',
...,
95: '#102069',
'@light': '$(blue-60)',
'@dark': '$(blue-50)'
},
invert: {
'@light': '#000000',
'@dark': '#ffffff'
},
...
}
```
You can also access filtered hue colors:
```js
import hueColors from '@master/colors/hue'
```
The `colors` object contains hue colors on a scale of `5~95`:
```js
{
blue: {
Expand Down
5 changes: 0 additions & 5 deletions packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,6 @@
"require": "./dist/index.cjs",
"import": "./dist/index.mjs",
"types": "./dist/index.d.ts"
},
"./hue": {
"require": "./dist/hue.cjs",
"import": "./dist/hue.mjs",
"types": "./dist/hue.d.ts"
}
},
"files": [
Expand Down

0 comments on commit a295594

Please sign in to comment.