Changeset 3380356

Timestamp:

10/17/2025 11:43:43 PM (4 months ago)

Author:

erikzett

Message:

Updated Readme

File:

• course-tracker/trunk/Readme.txt (modified) (5 diffs)

course-tracker/trunk/Readme.txt

@@ -1 @@
-=== Course Tracker ===
+=== Course Tracker – Simple WordPress Lesson Progress & LMS Navigation ===
 Contributors: erikzett
 Donate link: https://rankbydesign.com/course-tracker-donate
-Tags: lms, course, progress, tracking, completion
+Tags: lms, course, lesson, progress bar, lesson completion, course navigation, track lessons
 Requires at least: 5.0
 Tested up to: 6.8
@@ -9 +9 @@
 License: GPL2
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
-Track student progress in WordPress courses with simple navigation, completion buttons, and reports.
+Lightweight WordPress LMS plugin to track lessons, student progress, and completions — with visual progress bars, checkmarks, and easy course navigation.
 
 == Description ==
 
-**Course Tracker** is a modern, user-friendly plugin for managing courses and tracking student lesson completion. Designed for speed and simplicity, it works with any theme using a WordPress menu as your course navigation. Students can check off lessons, see their progress, and (optionally) back up or restore their data.
+**Course Tracker** is a lightweight, shortcode-driven WordPress plugin that lets you **build your own mini LMS directly inside WordPress** — no coding or external LMS required.  
 
-Features:
+It’s powered by the **WordPress Menu Builder**, which you use to structure your course outline. Each menu item (lesson) automatically becomes part of a side navigation panel — complete with **progress checkmarks and arrows** that update as students mark lessons complete.  
 
-- Easy setup – just assign a WordPress menu for your course.
-- Students mark lessons as complete with a click.
-- Visual navigation with checkmarks and arrows.
-- Progress bar and course outline display.
-- Slide-in course tracker panel (optional).
-- Works with all themes and page builders.
-- Minimal code, fast and standards-compliant.
+Fully compatible with **Classic Editor, Gutenberg, and all major page builders** such as Bricks Builder, Elementor, and Beaver Builder, Course Tracker helps you track lessons, show progress bars, and guide students through your course in a clean, visual way.
 
-**Perfect for:**
-- Course creators who want simple progress tracking.
-- Membership sites and online classes.
-- DIY educators who want flexibility and privacy.
-- Budget-conscious developers and admins who are creating a DIY course.
-- Freeing yourself from expensive LMS subscriptions
+Designed for creators who want course progress tracking without complex LMS setups, it delivers everything you need to create a motivating learning experience — fast, flexible, and privacy-friendly.
 
+### Key Features
+
+- **Shortcode-Driven:** Add course navigation, progress bars, and completion buttons anywhere — no coding required.  
+- **Menu-Based Navigation:** Uses the native WordPress Menu Builder to create your course outline and automatically show lesson checkmarks and arrows as students progress.  
+- **Lesson Completion Tracking:** Students can mark lessons complete and instantly see their updated progress.  
+- **Progress Bars & Checkmarks:** Display lesson progress visually with customizable bars, icons, and completion text.  
+- **Build Your Own LMS:** Create a complete learning experience directly inside WordPress — no third-party LMS plugins or subscriptions needed.  
+- **Works with All Editors:** Compatible with Classic Editor, Gutenberg, Bricks Builder, Elementor, and other page builders.  
+- **Lightweight & Fast:** Built for speed, simplicity, and compatibility with any theme.  
+- **Save & Restore Progress:** Students can export or import progress data anytime — no external accounts or sync required.  
+- **Privacy-First:** All progress data stays in your WordPress database, never sent elsewhere.
 
 == Installation ==
 
-1. Upload the plugin files to the `/wp-content/plugins/course-tracker` directory or install via the WordPress plugin installer.
-2. Activate the plugin.
-3. Go to **Settings > Course Tracker** to select your course navigation menu and configure options.
+1. Upload the plugin files to the `/wp-content/plugins/course-tracker` directory or install via the WordPress plugin installer.  
+2. Activate the plugin through the **Plugins** menu in WordPress.  
+3. Go to **Settings → Course Tracker** to select your course navigation menu and configure options.  
 4. Add shortcodes (see below) to your lesson or course pages.
 
@@ -44 +44 @@
 After setup, use these shortcodes in your pages or templates:
 
-* `[ctrkr_nav]` – Course navigation with checkmarks.
-* `[ctrkr_complete_button text=" "]` – Button to mark the current lesson as complete.
-* `[ctrkr_nav_arrows]` – Previous/Next lesson arrows.
-* `[ctrkr_course_outline]` – Progress bar and outline table.
-* `[ctrkr_lesson_position]` - Shows plain text: Lesson N of Total.
-* `[ctrkr_progress_text]` - Shows < Completed X of Y lessons > with prev/next arrows.
+* `[ctrkr_nav]` – Displays course navigation with checkmarks.  
+* `[ctrkr_complete_button text=" "]` – Adds a button to mark the current lesson as complete.  
+* `[ctrkr_nav_arrows]` – Adds Previous/Next lesson arrows.  
+* `[ctrkr_course_outline]` – Shows progress bar and course outline.  
+* `[ctrkr_lesson_position]` – Displays text like “Lesson X of Y.”  
+* `[ctrkr_progress_text]` – Displays “Completed X of Y lessons” with navigation arrows.
 
 **Example:**  
-Add `[ctrkr_nav]` to your sidebar or course page for navigation.  
-Add `[ctrkr_complete_button]` to each lesson page.
+Place `[ctrkr_nav]` in your sidebar or course page for navigation.  
+Add `[ctrkr_complete_button]` to each lesson page so students can mark it complete.  
 
 Students can also export their progress as a backup file (JSON) and import it later if needed.
@@ -59 +59 @@
 == Settings ==
 
-- **Course Navigation Menu:** Select the WordPress menu that represents your course.
-- **Show Navigation Title:** Display a title above the course navigation.
-- **Slide-in Tracker Panel:** Optionally enable a floating slide-in menu for navigation.
-- **Styling:** Change button color with color picker. Use provide examples for more customization.
-- **Student Reports:** See your students progress and export to a spreadsheet.
+- **Course Navigation Menu:** Choose the WordPress menu that represents your course.  
+- **Show Navigation Title:** Display a title above the course navigation.  
+- **Slide-in Tracker Panel:** Optionally enable a floating slide-in menu for navigation.  
+- **Styling:** Customize button colors with the built-in Button Styler, or fine-tune further using the WordPress Customizer or your theme’s CSS.  
+- **Student Reports:** View student progress and export to a spreadsheet.  
 
 == External Services ==
 
 This plugin connects to [SureCart](https://surecart.com/) via `api.surecart.com` for license verification (to unlock the premium version).  
-- **What:** The entered license key is sent to SureCart for validation.
-- **When:** Only when you enter or remove a license key in the plugin settings.
-- **Data sent:** License key (no student or course data is sent).
-- **Purpose:** To enable premium features after purchase.
+
+- **What:** The entered license key is sent to SureCart for validation.  
+- **When:** Only when you enter or remove a license key in the plugin settings.  
+- **Data sent:** License key only — no student or course data.  
+- **Purpose:** To enable premium features after purchase.  
 - [SureCart Privacy Policy](https://surecart.com/privacy-policy/)
 
 == Frequently Asked Questions ==
 
-= Does this plugin store student progress? =
-Yes. Student progress is stored privately in your WordPress database for each logged-in user, with no data sent to any third party. All plugin settings and user progress are included in regular WordPress database backups. To back up your WordPress site (including plugin data), use any popular backup plugin such as [UpdraftPlus](https://wordpress.org/plugins/updraftplus/).
+= Does this plugin require another LMS like LearnDash or TutorLMS? =  
+No. **Course Tracker is completely standalone** — it’s not an add-on for any LMS platform. It uses your WordPress menu system and shortcodes to build your own lightweight learning platform directly inside WordPress.
 
-= Can I use this with any theme? =
-Yes! Create a WordPress menu to organize your course. Insert the provided shortcodes into your page template (such as your lessons page or sidebar).
+= How does Course Tracker use the WordPress menu builder? =  
+Course Tracker connects to the **native WordPress Menu Builder** to create your course structure. Each menu item (lesson) becomes part of a visual course navigation panel. When a student marks a lesson as complete, a **checkmark** automatically appears next to that lesson.
 
-= Is this plugin free? =
-Yes. You can have 20 users (including admin) track their lessons for each license. Otherwise, no other restrictions. After 20 users, you can opt to unlock it for unlimited users for a small fee, which helps support this plugin and bring more improvements.
+= Do I need to code or edit templates? =  
+No coding is required. Course Tracker is **100% shortcode-driven**, so you can insert navigation, progress bars, and completion buttons anywhere. It works seamlessly with **Classic Editor, Gutenberg, Bricks Builder, Elementor**, and most other page builders.
+
+= Do I need to use all the shortcodes? Which ones are required? =  
+You only need to use the **course navigation** shortcode (`[ctrkr_nav]`) and the **complete button** shortcode (`[ctrkr_complete_button]`) for the plugin to function effectively.  
+However, we suggest adding all shortcodes to a test post to see what each one does and how they enhance your course layout.
+
+= Can I use this directly on a page or post? =  
+Yes, you can. But we recommend creating a **course or lesson template** in your page builder so your shortcodes appear consistently across all lessons. Otherwise, you’ll need to insert shortcodes manually on each page, which isn’t ideal.  
+For more about templates, please visit [rankbydesign.com](https://rankbydesign.com) and click **LMS** for video examples on building a course in Bricks Builder. More guides for other themes are coming soon, as Course Tracker works independently of any theme.
+
+= Can I style the buttons and navigation? =  
+Yes! The plugin includes a built-in **Button Styler** to easily change colors and styles. You can also fine-tune the look using the **WordPress Customizer or theme CSS**.  
+Need a hand matching your site’s design? **Reach out anytime** — we’re happy to help.
+
+= Where is student progress stored? =  
+All student progress is stored privately in your **own WordPress database** — never sent to any external service. Students can also export/import their own progress files if needed.
+
+= Does it work with my theme? =  
+Yes! Course Tracker is designed to work with **any modern WordPress theme or page builder.** Because it uses shortcodes and menus instead of theme-specific templates, it adapts cleanly to your layout.
+
+= Is Course Tracker free? =  
+Yes. You can track progress for up to **20 users** (including the admin) for free.  
+For larger sites or unlimited users, you can upgrade with a small one-time fee, which helps support ongoing improvements and new features.
 
 == Screenshots ==
 
-1. Setting page.
-2. Navigation Settings.
-3. Button Styling.
-4. Sticky Behavior.
-5. Student Progress.
-6. Lessons Example.
-7. Outline Example.
+1. Settings page.  
+2. Navigation setup.  
+3. Button styling.  
+4. Slide-in panel.  
+5. Student progress view.  
+6. Lesson example.  
+7. Course outline example.
 
 == Changelog ==
 
 = 1.1.6 =
-* Initial version released at WordPress Plugin Directory
-* Improved button styling.
-* Settings page improvements.
+* Initial version released at WordPress Plugin Directory  
+* Improved button styling and settings UI.  
 
 = 1.1.5 =
-* Refinements and options added to the Slide-in panel
+* Refinements and new options added to the Slide-in panel.  
 
 = 1.1.4 =
-* Fixed remaining domain handling errors with PCP
+* Fixed remaining domain handling errors with PCP.  
 
 = 1.1.3 =
-* Fixed domain handling and improved data sanitation, readme corrections and plugin code.
-* No changes to plugin features or functionality.
+* Fixed domain handling and improved data sanitation.  
+* No changes to plugin features or functionality.  
 
 = 1.1.0 =
-* Plugin completely refactored for simplicity and security.
-* Plugin always saves progress permanently to WP database even in free mode.
-* Free mode allows up to 20 users including admin - paid is unlimited
-* A new nav slide-in option can also be activated if needed.
-* Removed CSS edit box for simplicity - added a color select for button
-* All features now use unique prefixes and proper escaping.
-* New: Color Picker and Slide-in tracker panel.
-* Improved / Simplified: Admin settings and license activation.
+* Plugin completely refactored for simplicity and security.  
+* Always saves progress permanently to WP database, even in free mode.  
+* Free mode supports up to 20 users; premium unlocks unlimited.  
+* Added color picker and slide-in tracker panel.  
+* Improved admin settings and license activation.  
 
 = 1.0.0 =
@@ -129 +148 @@
 = 1.1.0 =
 Major update: Codebase simplified, improved security, new slide-in tracker. Please review your settings after updating.
-
-== License ==
-
-This plugin 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 the current version of the License, or (at your option) any later version.