add project documentation

xwp · Jul 24, 2024 · 0035faa · 0035faa
1 parent 109e86f
commit 0035faa
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/contributing.md b/contributing.md
@@ -55,6 +55,7 @@ We use npm as the canonical task runner for the project. The following commands
 - `npm run test` to run PHPunit tests inside the WordPress container.
 - `npm run test-xdebug` will run the PHPunit tests with Xdebug enabled.
 - `npm run switch-to:php7.4` and `npm run switch-to:php8.2` will switch you to either PHP 7.4 or PHP 8.2
+- `npm run document:connectors` generates [connectors.md](connectors.md). This runs via your local php.
 
 By default, tests have `WP_DEBUG` as false. You can override this if necessary by setting `WP_STREAM_TEST_DEBUG` to "yes".
 

diff --git a/readme.md b/readme.md
@@ -13,6 +13,10 @@
 
 View the [plugin description on WordPress.org](https://wordpress.org/plugins/stream/) for the list of features and screenshots.
 
+### Connectors
+
+A list of the connectors is in [connectors.md](connectors.md).
+
 
 ## Known Issues