Skip to content

Commit

Permalink
more detailed configuration example added in readme.md (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
krishna-gujjjar committed Apr 13, 2024
1 parent 1cfe476 commit b9d0d43
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ export default {

## Configuration

### Vite Config

You can customize the plugin by passing options during initialization:

```javascript
Expand All @@ -70,6 +72,15 @@ export default {
};
```

### Git Ignore

The `hot` file is created and deleted when the vite dev server is run, making it safe to ignore it. You can change the `hot` file path by update the config `hotFile` by default it's `public/hot` and add the path in the `.gitignore`.

```dockerfile
# @fabithub/vite-plugin-ci4
public/hot
```

## Options

| Configuration | Type | Default | Description |
Expand Down

0 comments on commit b9d0d43

Please sign in to comment.