=== Year Remaining ===
Contributors: andrewhoyer
Tags: year, date, time, calendar, progress
Requires at least: 5.2
Tested up to: 6.8.1
Stable tag: 0.3.1
Requires PHP: 7.0
Author URI: https://andrewhoyer.com/year-remaining/
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl-3.0.html

== Description ==

Year Remaining is a plugin that allows WordPress users to integrate the Year Remaining progress bar into the WordPress Dashboard as well as on pages or posts using a shortcode.

== How to use ==

There are three ways you can use this plugin.

= Shortcode =

Place the [year_remaining] shortcode anywhere on your site where shortcodes can be used.

= Dashboard =

The dashboard widget will be displayed automatically. Hide or show the widget as needed.

= Filter =

For developers, if you would like to modify the text output, use the year_remaining_filter_progress_bar filter to do so just before the text is written out to the page.

== Developers ==

If you're interested in furthering the development of the Year Remaining plugin, please find the project on GitHub:

<a href="https://github.com/andrewhoyer/wp-year-remaining/">https://github.com/andrewhoyer/wp-year-remaining/</a>

== Frequently Asked Questions ==

= How can I help? =

There are a few ways you can help make Year Remaining better and support more development:

* Install it on WordPress sites you manage
* Tell your friends, write a blog post, etc
* Follow the project on GitHub, and become a Contributor

== Changelog ==

= 0.3.1 - May 5, 2025 =

* Tested up to version 6.8.1

= 0.3 - Jan 28, 2024 =

* Improvements based on WordPress Plugin review

= 0.2 - Dec 12, 2023 =

* First release

== Screenshots ==

1. Year Remaining dashboard widget

2. Example use of the shortcode

== License ==

    Copyright (C) 2023 Andrew Hoyer

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program.  If not, see <https://www.gnu.org/licenses/>.


== Upgrade Notice ==