Browse Source

Update readme

Updates the readme for the new project home.
tags/1.0
Chris Wiegman 1 year ago
parent
commit
d18d77c70d
No known key found for this signature in database GPG Key ID: 449E180845071036
1 changed files with 5 additions and 93 deletions
  1. +5
    -93
      README.md

+ 5
- 93
README.md View File

@@ -1,7 +1,7 @@
UF Health WordPress Project Generator
WordPress Project Generator
=================

Generator-wp is a [Yeoman](http://yeoman.io) generator for generating a base WordPress plugin (with themes to come) or a test environment for WordPress itself for use on UF Health WordPress properties based, in part, on [generator-wp-make by 10up](https://github.com/10up/generator-wp-make).
Generator-wp is a [Yeoman](http://yeoman.io) generator for generating a base WordPress plugin (with themes to come) or a test environment for WordPress itself. It is forked from [generator-wp at UF Health](https://github.com/UFHealth/generator-wp) which is based, in part, on [generator-wp-make by 10up](https://github.com/10up/generator-wp-make).

## Installation

@@ -14,7 +14,7 @@ $ npm install -g yo
To install generator-wp clone this repository, enter the directory, and link it to npm:

```
$ git clone git@gitlab.ahc.ufl.edu:WebServices/generator-wp.git && cd generator-wp
$ git clone git@github.com:ChrisWiegman/generator-wp.git && cd generator-wp
$ npm install
$ npm link
```
@@ -36,7 +36,7 @@ For each project type you get:
- Grunt to streamline JS and CSS assets
- phpunit for PHP unit testing
- A fully-fleshed out, name-spaced setup for WordPress plugin development
- A Docker configuration, compatible with [Ouroboros](https://github.com/UFHealth/ouroboros), to get you actually working on code quickly.
- A Docker configuration, compatible with [Primary Docker](https://github.com/chriswiegman/primary-docker), to get you actually working on code quickly.

### Plugin

@@ -66,93 +66,5 @@ After installation is complete bring up the local environment in Docker with the

## Changelog

##### 2.1.2
* Setup the appropriate domain for debugging with wp-cli

##### 2.1.1
* Use appropriate user for XDebug scripts

##### 2.1
* Add scripts to enable and disable full-time listening for XDebug
* Updated export to work in Linux as well as Mac

##### 2.0.2
* Fix .htaccess for multisite with a new apache image

##### 2.0.1
* Make sure WordPress' rewrite rules are in place

##### 2.0
* Added the wp:core command to install a quick test environment.

##### 1.4
* Allow plugin setup without CSS or JS support
* Add Ouroboros-compatible Docker configuration to setup
* Allow UF Health prefix to be optional on setup
* Better handle plugin name, slug and other variables throughout the templates

##### 1.3.4
* Add code coverage information

##### 1.3.3
* Cleanup of existing templates
* Auto-initialize GIT repository
* Enable wp-enforcer

#### 1.3.2
* Fix wp-enforcer
* Drop WordPress VIP standards
* Minor name fixes

#### 1.3.1
* Don't use grunt/phpunt

#### 1.3
* Remove WP_Mock and use standard WordPress coding standards
* Ensure NPM packages are always up to date
* install composer an npm modules on use
* run grunt on initial setup

#### 1.2.7
* Update default packages in package.json

#### 1.2.6
* Defined the path to the includes folder in the main plugin file.

#### 1.2.5
* Updated PHPUnit to 6.5.* to address updates to wp_mock.

#### 1.2.4
* Fixed languages information in plugin index file

#### 1.2.3
* Update default URLs and author to be more inline with UF Health Webservices

#### 1.2.2
* Updated generated package.json for more current packages
* Update yeoman and related JS dependencies

#### 1.2.1
* Updated prompt descriptions for better clarity.

#### 1.2
* Add Grunt clean to plugin grunt processes
* Add dev and prod versions of compiled JS with appropriate mappings

#### 1.1.1
* Cleanup package versions in package.json
* Ignore vendor folder in .pot generation

#### 1.1
* Added Full GIT repository address to generated plugin.
* Added usage and build instructions to the readme.md file of generated plugins.

#### 1.0.2
* Add unit to plugin display name for easier sorting in WordPress dashboard

#### 1.0.1
* Replace Travis template with GitLab CI template
* Fix: Make sure source assets are not caught up in .gitignore.

#### 1.0
* Initial release
* Initial release after form from UF Health