modules-readme-updater — community modules-readme-updater, journalOS, community, ide skills, Claude Code, Cursor, Windsurf

v1.0.0
GitHub

About this Skill

Perfect for Documentation Agents needing automated README updates for modular projects like JournalOS JournalOS is a privacy-first, self-hosted personal journaling system with modular daily tracking (sleep, mood, work, health, and more).

djaiss djaiss
[0]
[0]
Updated: 3/3/2026

Agent Capability Analysis

The modules-readme-updater skill by djaiss is an open-source community AI agent skill for Claude Code and other IDE workflows, helping agents execute tasks with better context, repeatability, and domain-specific guidance.

Ideal Agent Persona

Perfect for Documentation Agents needing automated README updates for modular projects like JournalOS

Core Value

Empowers agents to maintain accurate and consistent documentation in Markdown format, ensuring modules are properly indented and listed alphabetically under the Features section, utilizing file formats like README.md

Capabilities Granted for modules-readme-updater

Updating module documentation after adding or removing a module
Renaming modules and reflecting changes in README.md
Automating documentation maintenance for modular daily tracking systems

! Prerequisites & Limits

  • Requires access to README.md file
  • Limited to Markdown format
  • JournalOS project context necessary
Labs Demo

Browser Sandbox Environment

⚡️ Ready to unleash?

Experience this Agent in a zero-setup browser environment powered by WebContainers. No installation required.

Boot Container Sandbox

modules-readme-updater

Install modules-readme-updater, an AI agent skill for AI agent workflows and automation. Works with Claude Code, Cursor, and Windsurf with one-command setup.

SKILL.md
Readonly

Modules README Updater

This Skill updates the project README.md to accurately document all existing journal modules in a clear, consistent, and properly indented structure under the Features section.

When to use this Skill

Use this Skill when:

  • A new module is added or removed
  • Module names change
  • The README documentation is outdated
  • You want to ensure modules are documented consistently and alphabetically

Instructions

Step 1: Locate the insertion point

  1. Open README.md.
  2. Start updating from line 12.
  3. Preserve existing indentation and formatting.

Step 2: Update the Features section

  1. Ensure the section header exists:

Features

  1. Under Features, add or update the parent bullet:
  • Daily logging of your life

Step 3: List all modules as sub-items

  1. Add all modules as child list items under “Daily logging of your life”.
  2. Each module must:
    • Be indented as a sub-list
    • Represent exactly one module
    • Use consistent naming

Example structure:

Features

  • Daily logging of your life
    • Energy
    • Health
    • Mood
    • Sexual activity
    • Sleep

Step 4: Alphabetical ordering

  1. Sort all module names alphabetically.
  2. Do not group, filter, or reorder manually beyond alphabetical order.
  3. Do not omit any existing module.

Step 5: Formatting rules

  • Use spaces, not tabs
  • Keep indentation consistent
  • Do not add descriptions or extra text
  • Do not modify other sections of README.md

Validation checklist

  • README.md updated starting at line 12
  • Features section exists
  • “Daily logging of your life” is the parent item
  • All modules are listed
  • Modules are alphabetically ordered
  • Markdown indentation is correct
  • No unrelated content was changed

Output expectation

The Features section clearly documents all journal modules as sub-features of daily life logging, using clean and valid Markdown.

FAQ & Installation Steps

These questions and steps mirror the structured data on this page for better search understanding.

? Frequently Asked Questions

What is modules-readme-updater?

Perfect for Documentation Agents needing automated README updates for modular projects like JournalOS JournalOS is a privacy-first, self-hosted personal journaling system with modular daily tracking (sleep, mood, work, health, and more).

How do I install modules-readme-updater?

Run the command: npx killer-skills add djaiss/journalOS/modules-readme-updater. It works with Cursor, Windsurf, VS Code, Claude Code, and 19+ other IDEs.

What are the use cases for modules-readme-updater?

Key use cases include: Updating module documentation after adding or removing a module, Renaming modules and reflecting changes in README.md, Automating documentation maintenance for modular daily tracking systems.

Which IDEs are compatible with modules-readme-updater?

This skill is compatible with Cursor, Windsurf, VS Code, Trae, Claude Code, OpenClaw, Aider, Codex, OpenCode, Goose, Cline, Roo Code, Kiro, Augment Code, Continue, GitHub Copilot, Sourcegraph Cody, and Amazon Q Developer. Use the Killer-Skills CLI for universal one-command installation.

Are there any limitations for modules-readme-updater?

Requires access to README.md file. Limited to Markdown format. JournalOS project context necessary.

How To Install

  1. 1. Open your terminal

    Open the terminal or command line in your project directory.

  2. 2. Run the install command

    Run: npx killer-skills add djaiss/journalOS/modules-readme-updater. The CLI will automatically detect your IDE or AI agent and configure the skill.

  3. 3. Start using the skill

    The skill is now active. Your AI agent can use modules-readme-updater immediately in the current project.

Related Skills

Looking for an alternative to modules-readme-updater or another community skill for your workflow? Explore these related open-source skills.

View All

widget-generator

Logo of f
f

f.k.a. Awesome ChatGPT Prompts. Share, discover, and collect prompts from the community. Free and open source — self-host for your organization with complete privacy.

149.6k
0
AI

flags

Logo of vercel
vercel

flags is a Next.js feature management skill that enables developers to efficiently add or modify framework feature flags, streamlining React application development.

138.4k
0
Browser

zustand

Logo of lobehub
lobehub

The ultimate space for work and life — to find, build, and collaborate with agent teammates that grow with you. We are taking agent harness to the next level — enabling multi-agent collaboration, effortless agent team design, and introducing agents as the unit of work interaction.

72.8k
0
AI

data-fetching

Logo of lobehub
lobehub

The ultimate space for work and life — to find, build, and collaborate with agent teammates that grow with you. We are taking agent harness to the next level — enabling multi-agent collaboration, effortless agent team design, and introducing agents as the unit of work interaction.

72.8k
0
AI