=== Lechwe Read Status ===
Contributors:      petergerard
Donate link:       https://paypal.me/pgice
Tags:              block, read status, mark read, mark unread
Tested up to:      7.1
Stable tag:        0.1.1
License:           GPLv3
License URI:       https://www.gnu.org/licenses/gpl-3.0.html

Block to allow logged-in users to mark posts as read or unread.

== Description ==

Allow readers of your posts to mark what they have read or completed so they can keep track of their progress.

This plugin serves various needs - maybe you have a blog and want your users to be able to keep track of what they have read or haven't read. Or you offer online courses and readers need to mark off what they have completed - sometimes a full Learning Management System is overkill and you just want a simple way for readers to toggle completed/read posts.

You need to be using the Block Editor since this plugin is only active on posts where you add the "Mark Read" block. You can customize the labels shown per-post, e.g. "Mark completed" or "Mark read" or whatever you want. 

Readers must be logged in to see the button. They can then click the button to toggle their individual status for each post. When they have marked a post as read, the title is displayed with a ✅ throughout the site, so they can easily see which posts have been read and which have not. 

== Installation ==

1. Upload the plugin files to the `/wp-content/plugins/lechwe-read-status` directory, or install the plugin through the WordPress plugins screen directly.
1. Activate the plugin through the 'Plugins' screen in WordPress
1. Add the "Mark Read" block to your post(s).


== Frequently Asked Questions ==

= Do users have to be logged in? =

Yes, users must be logged in to mark posts as read or unread. 

= Can I trigger actions from status changes? =

Yes, there are actions you can hook. They are fired whenever a user changes the status.

`do_action( 'mark_read_change_to_read', $post_id, $user_id );`
`do_action( 'mark_read_change_to_unread', $post_id, $user_id );`

= What happens if I uninstall? =

If you uninstall the plugin, all user read-statuses will be fully deleted from the database.

== Screenshots ==

1. Button with unread status in a post
2. Button with read status in a post 
3. Post titles with status displayed

== Changelog ==

= 0.1.1 =
* Initial release

