Skip to content

Commit 7d13894

Browse files
authored
Fix core README (#42)
1 parent 833b18e commit 7d13894

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

packages/cli/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Cobalt UI
22

3-
Schemas and tools for managing design tokens.
3+
CLI for managing [W3C Design Token format](https://www.w3.org/community/design-tokens/) design systems.
44

55
## Usage
66

packages/core/README.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
# @cobalt-ui/core
22

3-
Parse a `tokens.json` schema, validate it for errors, and return tokens as a
4-
normalized, flattened array.
3+
Node.js API for managing [W3C Design Token format](https://www.w3.org/community/design-tokens/) design systems.
54

6-
Use `@cobalt-ui/core` in the browser or in Node.js.
7-
8-
For building tokens and syncing with Figma, use `@cobalt-ui/cli`.
5+
For the CLI, use `@cobalt-ui/cli`.
96

107
## Install
118

@@ -23,9 +20,9 @@ import co from '@cobalt-ui/core';
2320

2421
const designTokens = {
2522
color: {
26-
red: {type: 'color', value: '#e34850'},
27-
green: {type: 'color', value: '#2d9d78'},
28-
blue: {type: 'color', value: '#2680eb'},
23+
red: {$type: 'color', $value: '#e34850'},
24+
green: {$type: 'color', $value: '#2d9d78'},
25+
blue: {$type: 'color', $value: '#2680eb'},
2926
},
3027
};
3128

0 commit comments

Comments
 (0)