Skip to content

Commit

Permalink
docs: fix description for cli
Browse files Browse the repository at this point in the history
  • Loading branch information
yarastqt committed May 8, 2020
1 parent c3eb467 commit 695566b
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@ Themkit is a build system for design-tokens on any platform. This system is base

## Contents

* [Features](#features)
* [Installation](#installation)
* [Getting start](#getting-start)
* [Configuration](#configuration)
* [Example](#example)
* [Tokens](#tokens)
* [Extending](#extending)
* [License](#license)
- [Features](#features)
- [Installation](#installation)
- [Getting start](#getting-start)
- [Configuration](#configuration)
- [Example](#example)
- [Tokens](#tokens)
- [Extending](#extending)
- [License](#license)

## Features

* πŸ“š Define tokens once and get result for any format, for example js, css or json.
* πŸ›  Every part of the theme or some of the tokens is extendable and overridable.
* πŸ’» Tokens may be defined for each platforms, for example desktop and touch.
* πŸ” Supports typescript extension with type checking.
* πŸ—οΈ Available extends for new formats or transformations.
- πŸ“š Define tokens once and get result for any format, for example js, css or json.
- πŸ›  Every part of the theme or some of the tokens is extendable and overridable.
- πŸ’» Tokens may be defined for each platforms, for example desktop and touch.
- πŸ” Supports typescript extension with type checking.
- πŸ—οΈ Available extends for new formats or transformations.

## Installation

Expand All @@ -36,19 +36,19 @@ You can use Themekit as cli or node api.

### cli

Build tokens for all formats:
Builds tokens for configured formats:

```sh
themekit build
```

Call this in the root directory of your project. The only thing needed is a `themekit.config.js` file. There are also arguments:

| Flag | Description |
|--------------------|-------------|
| --config -c [path] | β€” |
| --help | β€” |
| --version | β€” |
| Flag | Description |
| ------------------ | ----------------------------------- |
| --config -c [path] | The path to a themekit config file. |
| --help | Show help with usage. |
| --version | Show current package version. |

### node

Expand Down Expand Up @@ -79,7 +79,7 @@ Each platform contains one or more levels, and tokens declared on these levels w
Default set of available platforms:
| platform | levels |
|-------------|-----------------------------------|
| ----------- | --------------------------------- |
| common | common |
| deskpad | common, deskpad |
| desktop | common, deskpad, desktop |
Expand Down Expand Up @@ -192,7 +192,7 @@ Add tokens for two platforms `common` and `desktop`, we also need to add meta se

```ts
// src/themes/tokens/space.tokens.ts
import { withTokens } from '@yandex/themekit';
import { withTokens } from '@yandex/themekit'

export const tokens = {
space_m: '20px',
Expand Down

0 comments on commit 695566b

Please sign in to comment.