diff --git a/.wordpress-org/banner-1544x500.png b/.wordpress-org/banner-1544x500.png index 3ce781b..5f555b2 100644 Binary files a/.wordpress-org/banner-1544x500.png and b/.wordpress-org/banner-1544x500.png differ diff --git a/.wordpress-org/banner-772x250.png b/.wordpress-org/banner-772x250.png index c090ba9..1c2009f 100644 Binary files a/.wordpress-org/banner-772x250.png and b/.wordpress-org/banner-772x250.png differ diff --git a/.wordpress-org/icon-256x256.png b/.wordpress-org/icon-256x256.png index bda43d4..914a31f 100644 Binary files a/.wordpress-org/icon-256x256.png and b/.wordpress-org/icon-256x256.png differ diff --git a/.wordpress-org/icon-512x512.png b/.wordpress-org/icon-512x512.png index 6c037ef..15d4034 100644 Binary files a/.wordpress-org/icon-512x512.png and b/.wordpress-org/icon-512x512.png differ diff --git a/README.md b/README.md index 540869d..096471d 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,33 @@ -# OmniForm +# OmniForm: Form Building inside the Block Editor + +[![OmniForm](.wordpress-org/banner-1544x500.png)](https://omniform.io/) OmniForm is a powerful WordPress plugin that allows you to create and manage forms within your WordPress site. +## Requirements + +- PHP 7.4+ +- [WordPress](http://wordpress.org/) 6.2+ + ## Installation -### Requirements +[Download the latest release from Github](https://github.com/jrtashjian/omniform/releases/latest). -- [Node.js](https://nodejs.org) -- [Composer](https://getcomposer.org) +You can upload and install the archived (zip) plugin via the WordPress dashboard (`Plugins` > `Add New` -> `Upload Plugin`) or manually inside of the `wp-content/plugins` directory, and activate on the Plugins dashboard. -### Quick Start +## Development Clone this repository: - ``` git clone https://github.com/jrtashjian/omniform.git ``` Install the necessary Node.js and Composer dependencies: - ``` -$ composer install -$ npm install +composer install && npm install ``` -### Available CLI commands - -- `composer lint` : checks all PHP files for syntax errors. -- `composer format` : fixes all automatically fixable syntax errors. -- `npm run wp-env` : exposes all commands available in [`@wordpress/env`](https://github.com/WordPress/gutenberg/tree/wp/6.0/packages/env) -- `npm run build` : compiles all scripts and styles distribution. -- `npm run dev` : compiles all scripts and styles for development. +Run the development build which will watch for changes: +``` +npm run dev +``` \ No newline at end of file