Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cearls committed Aug 29, 2022
1 parent 278e26f commit 1b303d6
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ Timberland builds your css and js files using Laravel Mix. This allows you to us

To build your assets for development, run `npm run development` or `npm run watch` from the theme directory in the terminal.

### Browsersync

To use Browsersync during local development, rename `browsersync.config-sample.js` to `browsersync.config.js` and update the proxy to match your local development URL. Other options can be seen in the [Browsersync documentation](https://browsersync.io/docs/options/).

### Versioning

To assist with long-term caching, file hashing (e.g. `app.js?id=8e5c48eadbfdd5458ec6`) is enabled by default. This is useful for cache-busting purposes.

## Production

When you're ready for production, run `npm run production` from the theme directory in the terminal.
Expand All @@ -30,14 +38,6 @@ If you're developing locally and moving files to your production environment, on
├── vendor/
```

### Browsersync

To use Browsersync during local development, rename `browsersync.config-sample.js` to `browsersync.config.js` and update the proxy to match your local development URL. Other options can be seen in the [Browsersync documentation](https://browsersync.io/docs/options/).

### Versioning

To assist with long-term caching, file hashing (e.g. `app.js?id=8e5c48eadbfdd5458ec6`) is enabled by default. This is useful for cache-busting purposes.

## Blocks

A block is a self-contained page section and includes its own template, script, style and functions files.
Expand Down

0 comments on commit 1b303d6

Please sign in to comment.