Skip to content

docs: refresh README and trim CLAUDE.md#3182

Merged
marevol merged 2 commits into
masterfrom
docs/refresh-readme-and-claude-md
Jul 5, 2026
Merged

docs: refresh README and trim CLAUDE.md#3182
marevol merged 2 commits into
masterfrom
docs/refresh-readme-and-claude-md

Conversation

@marevol

@marevol marevol commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Summary

Refresh README.md for an open-source audience and trim CLAUDE.md to essential guidance.

README.md

  • Add Features, Requirements (Java 21+, OpenSearch backend), Contributing, and License sections
  • Fix the License badge, which linked to another project's LICENSE, to point at this repository's LICENSE
  • Bump version references from 15.6 to 15.7
  • Group Theme / Ingest / Script under a single Plugins section and add a Community and Support section
  • Naturalize the Overview prose and keep the existing structure, screenshots, and links

CLAUDE.md

  • Trim to essential, non-obvious guidance (~208 → ~98 lines)
  • Remove the large directory tree, the generic naming-convention table, and derivable navigation tables
  • Keep the LastaFlute/DBFlute patterns, the password-hashing note, i18n propagation rules, and the WAR→jar install tip

No source or configuration files are changed.

marevol added 2 commits July 5, 2026 18:05
Update README.md for an OSS audience: add Features, Requirements, Contributing, and License sections; fix the License badge to point at the project LICENSE; bump version references from 15.6 to 15.7; group Theme/Ingest/Script under a Plugins section; and naturalize the prose.

Trim CLAUDE.md to essential, non-obvious guidance: remove the directory tree, naming-convention table, and derivable navigation while keeping the LastaFlute/DBFlute patterns, password-hashing note, and i18n rules.
@marevol marevol merged commit 8f3af30 into master Jul 5, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant