Skip to content

Commit 8c94fed

Browse files
committed
feat: Improved documentation
1 parent edfe5b1 commit 8c94fed

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,3 +143,21 @@ To install the latest version of this package over what's included in WP-CLI, ru
143143
wp package install git@github.com:igorhrcek/wp-cli-secure-command.git
144144
```
145145

146+
## Development and testing
147+
You need to set up two working WordPress installations on Apache and nginx. Usage of Docker containers is highly recommended - you can use the official WordPress Docker containers, BitNami or bootstrap your environment using [ddev](https://ddev.readthedocs.io/en/stable/users/cli-usage/#wordpress-quickstart).
148+
149+
For testing you need to create `.env` file with the following content:
150+
```
151+
WORDPRESS_NGINX_PATH=wp/nginx
152+
WORDPRESS_NGINX_URL=https://wpnginx.ddev.site
153+
WORDPRESS_APACHE_PATH=wp/apache
154+
WORDPRESS_APACHE_URL=https://wpapache.ddev.site
155+
```
156+
157+
These paths and URLs are going to be used during tests, so make sure that they are accessible.
158+
159+
## Contributing
160+
We appreciate you taking the initiative to contribute to this project.
161+
162+
Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.
163+

0 commit comments

Comments
 (0)