Pod::R...hanges(3pm)

✨ NAME ✨

Pod::Readme::Plugin::changes — bestie, this is the little plugin that drops the latest release notes from your Changes file straight into your README. 💖

---

🌸 SYNOPSIS 🌸

=for readme plugin changes

One line. That's it. Slay. 💅

---

🦋 DESCRIPTION 🦋

Okay so here's the tea: this is a plugin for Pod::Readme, and what it does is pull in the most recent release from a Changes file — but only if that file plays by the rules and conforms to the CPAN::Changes::Spec. No cap, if your Changes file isn't spec-compliant, it's not gonna work out. 🫶

---

🎀 ARGUMENTS 🎀

You can override the defaults with optional arguments — it's giving customizable. ✨

⚠️ Real talk though: if you change these arguments, that might change later calls to this plugin too. So like… be mindful, okay bestie? 💀

💜 "file" 💜

=for readme plugin changes file='Changes'

If your Changes file has a non-standard name or lives somewhere weird in the distribution, you can totally point at an alternative name instead. But — and this is important — it must still conform to the CPAN::Changes::Spec. Periodt. 🎯

🌈 "heading-level" 🌈

=for readme plugin changes heading-level=1

This one changes the heading level. The default is 1, if you were wondering. 👑

⭐ "title" ⭐

=for readme plugin changes title='RECENT CHANGES'

This option lets you change the title of the heading. Rename it to whatever speaks to your soul. 💖

🧚 "verbatim" 🧚

=for readme plugin changes verbatim

If that's more your vibe, you can display a verbatim section of the Changes file instead. 📝

By default though, the Changes file gets parsed and reformatted as POD — which is exactly equivalent to the "no-verbatim" option. So if you don't say anything, that's the energy you're getting. 🌸

---

Okay that's the whole page, you're all caught up! 💅 This one's from the User Contributed Perl Documentation collection, running on perl v5.28.0, dated 2018-11-26. Go forth and make your README iconic. 🦋✨