Skip to content

Commit

Permalink
docs (README) : complete README
Browse files Browse the repository at this point in the history
  • Loading branch information
firestar300 committed Dec 8, 2021
1 parent 64b7e43 commit 7a6cd14
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Vite WordPress
# Vite ⚡️ WordPress

Vite WordPress is a simple and quick WordPress starter theme using the fastest build tool: [Vite](https://vitejs.dev/).

## Get started
## Get started 🚀

### Set WP_ENV constant

In your `wp-config.php` file, you have define a `WP_ENV` constant according to your environment so that Vite WordPress can determine which assets need to be loaded.
In your `wp-config.php` file, you have to define a `WP_ENV` constant according to your environment so that Vite WordPress can determine which assets need to be loaded.
In case you are in development mode, set the constant to `development`.

```php
Expand All @@ -29,6 +29,23 @@ $ yarn
$ npm install
```

## [Change logs](CHANGELOG.md)
### Development 🛠

Run your local backend server, then in your theme run :
```bash
$ yarn dev
```

### Build 📦

```bash
$ yarn build
```

## Known issues 🪲

## Readme coming soon...
### HTTPS

The theme currently doesn't work in dev environment with a https server. There is an infinite HMR reloading loop.

## [Change logs](CHANGELOG.md)

0 comments on commit 7a6cd14

Please sign in to comment.