Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README.md #21

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Add README.md #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Storefront Hamburger Menu

Storefront Hamburger Menu turns the default handheld navigation into an off-screen sidebar menu with a "hamburger" toggle.

## Links

- Extension: https://woocommerce.com/products/storefront-hamburger-menu/
- Docs: https://wordpress.org/plugins/storefront-hamburger-menu/#installation

## NPM scripts

Storefront Hamburger Menu utilizes npm scripts for task management utilities.

- `npm run build`: Builds `storefront-hamburger-menu.zip`. Woorelease expects the product zip to be created using the `build` command.
- `npm run build:dev`: Builds from development files and folders without creating a product zip file.
- `npm run makepot`: Creates `storefront-hamburger-menu.pot` in `/languages`
- `npm run start`: Watches for changes to development files and builds assets for easier development.
- `npm run css`: Creates css assets from source(s) in `/src/scss`
- `npm run js`: Creates js assets from source(s) in `/src/js`