readme-auto-updater

Automatically update a Next.js README.md by scanning project metadata and Git history to reflect recent codebase changes. The tool uses Python and GitPython to dynamically generate and incrementally update documentation without manual intervention.

Integrate README generation into a CI/CD pipeline for Next.js projects to continuously maintain accurate documentation. The automation scans for project updates and module completions, triggering incremental README updates whenever new features or dependencies are added.

The automated README updater works with Python libraries like pypdf2 and pdf2image to process file metadata during codebase scanning. It relies on these dependencies, alongside GitPython and tabulate, to analyze project files and format the documentation output.

Enforce compliant terminology in Next.js documentation by integrating JKKN-terminologies during the automated README generation process. The scanning scripts check project metadata against these terminologies to ensure precise and standardized documentation output.

Mark a Next.js module as complete to trigger an incremental README file update reflecting the new project status. The automation continuously scans for these project updates, dynamically modifying the documentation to match the current codebase state.