Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add installation note
  • Loading branch information
arkarlov authored Sep 25, 2024
1 parent 84be101 commit 0e49c61
Showing 1 changed file with 5 additions and 15 deletions.
20 changes: 5 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,10 @@ or
```bash
yarn add react-style-stringify
```

> **Note for TypeScript users**: This package uses the `CSSProperties` type from `@types/react`. If you're working with TypeScript and don't use React, install the type definitions:
>
> ```bash
> npm install --save-dev @types/react
> ```
>
> or
>
> ```bash
> yarn add -D @types/react
> ```
> [!NOTE]
> This package uses the `CSSProperties` type from `@types/react`.
>
> If you're working with TypeScript and don't use React, install `@types/react`.
## Usage

Expand Down Expand Up @@ -97,13 +89,11 @@ When set `important` argument to `true`, appends `!important` to each CSS proper

## Dependencies

This package uses the following dependencies:

- **[@emotion/unitless](https://www.npmjs.com/package/@emotion/unitless)**: Handles checking for CSS properties that are unitless (e.g., `line-height`, `z-index`, etc.).

## Requirements

- **[@types/react](https://www.npmjs.com/package/@types/react)**: The package uses React's CSSProperties type for defining style objects.
- **[@types/react](https://www.npmjs.com/package/@types/react)**: The package uses React's `CSSProperties` type for defining style objects.

## Contributing

Expand Down

0 comments on commit 0e49c61

Please sign in to comment.