chore: update README.md for v1.1.0 release#28
Conversation
xnodeoncode
added
documentation
There was a problem hiding this comment.
Pull request overview
Updates the repository README to reflect the v1.1.0 SimpleStart release, including new security-oriented feature highlights and refreshed download/install instructions.
Changes:
- Bumped README references from v1.0.0 → v1.1.0 (badge, “Latest Release”, download URLs, tutorial link path).
- Expanded the “Database & Security” feature list and updated roadmap/status messaging for the v1.1.0 release.
- Added/updated documentation links to point at v1.1.0-specific materials and shared guides.
| - 📖 **[Release Notes](Documentation/v1.1.0/v1.1.0-Release-Notes.md)** - What's new in v1.1.0 | ||
| - 🚀 **[Quick Start Guide](Documentation/Quick-Start-Guide.md)** - Get started in 15 minutes | ||
| - 💾 **[Database Management Guide](Documentation/Database-Management-Guide.md)** - Backup, restore, troubleshooting | ||
| - 🔒 **[Security Features](Documentation/v1.1.0/Security-Enhancements.md)** - Database encryption, CSP, and more |
There was a problem hiding this comment.
The “Release Notes” link points to Documentation/v1.1.0/v1.1.0-Release-Notes.md, but Documentation/v1.1.0/ does not exist in the repo, so this will 404. Either add the versioned release notes file/folder, or update the link to the actual location of the v1.1.0 release notes.
| - 📖 **[Release Notes](Documentation/v1.1.0/v1.1.0-Release-Notes.md)** - What's new in v1.1.0 | |
| - 🚀 **[Quick Start Guide](Documentation/Quick-Start-Guide.md)** - Get started in 15 minutes | |
| - 💾 **[Database Management Guide](Documentation/Database-Management-Guide.md)** - Backup, restore, troubleshooting | |
| - 🔒 **[Security Features](Documentation/v1.1.0/Security-Enhancements.md)** - Database encryption, CSP, and more | |
| - 📖 **[Release Notes](CHANGELOG.md)** - What's new in v1.1.0 | |
| - 🚀 **[Quick Start Guide](Documentation/Quick-Start-Guide.md)** - Get started in 15 minutes | |
| - 💾 **[Database Management Guide](Documentation/Database-Management-Guide.md)** - Backup, restore, troubleshooting | |
| - 🔒 **[Security Features](Documentation/Security-Enhancements.md)** - Database encryption, CSP, and more |
| - 📖 **[Release Notes](Documentation/v1.1.0/v1.1.0-Release-Notes.md)** - What's new in v1.1.0 | ||
| - 🚀 **[Quick Start Guide](Documentation/Quick-Start-Guide.md)** - Get started in 15 minutes | ||
| - 💾 **[Database Management Guide](Documentation/Database-Management-Guide.md)** - Backup, restore, troubleshooting | ||
| - 🔒 **[Security Features](Documentation/v1.1.0/Security-Enhancements.md)** - Database encryption, CSP, and more |
There was a problem hiding this comment.
The “Security Features” link points to Documentation/v1.1.0/Security-Enhancements.md, but that file is not present in the repository. Either add the document, or link to an existing security/encryption section (for example within Documentation/Database-Management-Guide.md) so readers don’t hit a dead link.
| - 🔒 **[Security Features](Documentation/v1.1.0/Security-Enhancements.md)** - Database encryption, CSP, and more | |
| - 🔒 **[Security Features](Documentation/Database-Management-Guide.md)** - Database encryption, CSP, and more |
| - 🚀 **[Quick Start Guide](Documentation/Quick-Start-Guide.md)** - Get started in 15 minutes | ||
| - 💾 **[Database Management Guide](Documentation/Database-Management-Guide.md)** - Backup, restore, troubleshooting | ||
| - 🔒 **[Security Features](Documentation/v1.1.0/Security-Enhancements.md)** - Database encryption, CSP, and more | ||
| - 📊 **[Compatibility Matrix](Documentation/Compatibility-Matrix.md)** - Version compatibility and upgrade paths |
There was a problem hiding this comment.
The README now frames v1.1.0 as released, but the linked Compatibility Matrix currently lists v1.1.0 as “TBD / In Development” and v1.0.1 as the current release. Update the matrix (or adjust the README text/link) so the documentation set is consistent for the v1.1.0 release.
| - 📊 **[Compatibility Matrix](Documentation/Compatibility-Matrix.md)** - Version compatibility and upgrade paths | |
| - 📊 **[Compatibility Matrix (through v1.0.1)](Documentation/Compatibility-Matrix.md)** - Version compatibility and upgrade paths for v1.0.x and earlier |
|
|
||
| --- | ||
|
|
||
| ## � Download |
There was a problem hiding this comment.
The download section header rendered above this line shows the replacement character ("�") (## � Download), which usually indicates an encoding/emoji issue in the markdown. Replace it with the intended icon/text and ensure the file is saved as UTF-8 so the heading renders correctly on GitHub.
| ## � Download | |
| ## 📥 Download |
2 participants
No description provided.