Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
johnchourajr authored May 29, 2024
1 parent 47ef2ad commit 4d194b4
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A utility library for managing typographic scales in Tailwind CSS or React.

## Usage

## Add Plugin
### Add Plugin

```tsx
// tailwind.config.js
Expand Down Expand Up @@ -72,7 +72,13 @@ module.exports = {
};
```

### Defaults
3. Use tailwind utility classes in the code

```tsx

```

## Defaults
The [default styles](https://github.com/johnchourajr/buen-type/blob/main/src/defaults.ts) establish a basic type scale for building upon

#### Default Headline Types
Expand All @@ -92,7 +98,7 @@ These are the default text types that can be used in the project:
- body
- caption

### Type Properties
## Type Properties

| Property | Type | Description |
| --------------- | ------------------ | ------------------------------------------------------------ |
Expand All @@ -104,7 +110,7 @@ These are the default text types that can be used in the project:
| `fontSize` | `string` | The size of the font. |
| `clamp` | `[number, number]` | A tuple defining the minimum and maximum sizes for clamping. |

### Custom Types
## Custom Style Types

Example Usage
Here's an example of how you might define custom type definitions:
Expand Down

0 comments on commit 4d194b4

Please sign in to comment.