Skip to content

Commit a17b273

Browse files
committed
Updated README
1 parent 8127de1 commit a17b273

File tree

2 files changed

+80
-3
lines changed

2 files changed

+80
-3
lines changed

plugins/wpgraphql-logging/README.md

Lines changed: 79 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,92 @@ A WPGraphQL logging plugin that provides visibility into request lifecycle to he
55
* [Join the Headless WordPress community on Discord.](https://discord.gg/headless-wordpress-836253505944813629)
66
* [Documentation](#getting-started)
77

8+
> [!CAUTION]
9+
> This plugin is currently in development state and is not production ready.
810
911
-----
1012

11-
TODO
13+
@TODO - Badges
1214

1315
-----
1416

1517

1618

17-
> [!CAUTION]
18-
> This plugin is currently a POC and not production ready yet.
19+
## Table of Contents
20+
21+
- [Overview](#overview)
22+
- [Features](#features)
23+
- [Getting Started](#getting-started)
24+
- [Configuration](#configuration)
25+
- [Extending the Functionality](#extending-the-functionality)
26+
- [Testing](#testing)
27+
28+
29+
-----
30+
31+
## Overview
32+
33+
34+
WPGraphQL Logging is a plugin that integrates directly with the WPGraphQL Query Lifecycle, capturing detailed information about each GraphQL request. By leveraging the powerful [Monolog](https://github.com/Seldaek/monolog) logging library, it records events and metrics that help you quickly identify performance bottlenecks and other issues in your headless WordPress application.
35+
36+
Designed with extensibility in mind, developers can easily customize and extend the logging functionality to suit their specific needs, making it a valuable tool for debugging and optimizing WPGraphQL-powered sites.
37+
38+
---
39+
40+
## Features
41+
42+
@TODO
43+
44+
45+
## Getting Started
46+
47+
@TODO
48+
49+
50+
---
51+
52+
## Project Structure
53+
54+
```text
55+
wpgraphql-logging/
56+
├── src/ # Main plugin source code
57+
│ ├── Admin/ # Admin settings, menu, and settings page logic
58+
│ ├── Events/ # Event definitions and event dispatcher logic
59+
│ ├── Hooks/ # WordPress hooks and filters
60+
│ ├── Logging/ # Logging logic, logger service, Monolog handlers & processors
61+
│ ├── Plugin.php # Main plugin class (entry point)
62+
│ └── Autoload.php # PSR-4 autoloader
63+
├── tests/ # All test suites
64+
│ ├── wpunit/ # WPBrowser/Codeception unit tests
65+
├── [wpgraphql-logging.php]
66+
├── [activation.php]
67+
├── [composer.json]
68+
├── [deactivation.php]
69+
├── [ACTIONS_AND_FILTERS.md]
70+
├── [TESTING.md]
71+
├── [README.md]
72+
```
73+
74+
## Configuration
75+
76+
@TODO - When we integrate plugin configuration.
77+
78+
### Settings
79+
80+
@TODO - When we integrate plugin configuration.
1981

2082
---
83+
84+
## Actions & Filters
85+
86+
See the [Actions & Filters documentation](ACTIONS_AND_FILTERS.md) for a comprehensive list of available hooks and how to use them.
87+
88+
---
89+
90+
## Testing
91+
92+
See [Testing.md](TESTING.md) for details on how to test the plugin.
93+
94+
## Screenshots
95+
96+
@TODO - When before BETA release.

plugins/wpgraphql-logging/readme.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ License URI: https://www.gnu.org/licenses/gpl-2.0.html
1313

1414
A WPGraphQL logging plugin that provides visibility into request lifecycle to help quickly identify and resolve bottlenecks in your headless WordPress application.
1515

16+
@TODO
1617
== Upgrade Notice ==
1718
== Frequently Asked Questions ==
1819
== Screenshots ==

0 commit comments

Comments
 (0)