generated from jrtashjian/pluginwp
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update plugin assets and GitHub readme
- Loading branch information
1 parent
e5d500d
commit 1b49c1c
Showing
5 changed files
with
16 additions
and
16 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |