Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 925 Bytes

getting-started.md

File metadata and controls

34 lines (25 loc) · 925 Bytes

Getting started


Prerequisites

The plugin requires PHP 7.4+ and Composer


Installation

For the installation of the plugin, you have 2 choices.

Global installation

You can install the plugin on your computer with the following command

composer global require "spiriitlabs/composer-write-changelogs"

Local installation

You can also install the plugin in a single project with this command

composer require "spiriitlabs/composer-write-changelogs"

Usage

Once the plugin is installed, it will be launched automatically when the dependency is updated by Composer
You can find all of your updates summary on you changelogs folder with name changelogs-<date>-<hour>.<txt/json>

If you no longer want to display summary, you can either: