Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
williamgrosset committed May 17, 2024
1 parent 40c5a04 commit 92a5c2a
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# πŸ”Œ plugin

The abstract `Plugin` class for creating plugins.

From publishing `npm` packages, pushing changes to `git` repositories, to integrating with services like GitHub, Slack, or DoorDash, plugins can be created for a wide range of functionalities. The `Plugin` class provides a variety of utility methods and lifecycle hooks that integrate directly with [packpub](https://github.com/packpub/packpub).
The abstract `Plugin` class provides a variety of utility methods and lifecycle hooks for creating plugins. From publishing `npm` packages, pushing changes to `git` repositories, to integrating with services like GitHub, Slack, or DoorDash, plugins can be created for a wide range of functionalities.

### πŸ”₯ Features

Expand All @@ -13,7 +11,7 @@ From publishing `npm` packages, pushing changes to `git` repositories, to integr
- πŸ“ Console Logging
- πŸ”„ Lifecycle Hooks

View the [API](#api) for more information.
Learn more about the [API](#api).

## Requirements

Expand Down Expand Up @@ -100,7 +98,7 @@ Plugins support flags that can modify the execution of various utility methods a
| **dry** | When set to `true`, the plugin runs in dry mode and no write operations will be performed. |
| **headless** | When set to `true`, the plugin runs in headless mode and user prompts will return defaults and write-based shell execution will be ignored. |

> [!NOTE]
> [!IMPORTANT]
> Flags are set from the packpub CLI
## Examples
Expand Down

0 comments on commit 92a5c2a

Please sign in to comment.