[PR #8093] [CLOSED] docs: rephrase README.md #7742

Closed
opened 2026-03-13 13:47:51 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/8093
Author: @himself65
Created: 2/22/2026
Status: Closed

Base: canaryHead: himself65/2026/02/22/readme-rephrase


📝 Commits (1)

  • 31af504 docs: rephrase README.md for conciseness

📊 Changes

1 file changed (+17 additions, -22 deletions)

View changed files

📝 README.md (+17 -22)

📄 Description

This PR makes the README.md more concise by:

  • Condensing the "About the Project" section
  • Simplifying the "Why Better Auth" explanation
  • Tightening up the "Contributing" section
  • Shortening the "Security" section

No content was removed, only phrasing was tightened for better readability.


Summary by cubic

Rephrased and cleaned up README to be shorter and easier to scan, without removing content. Improves clarity in key sections and tidies header markup.

  • Refactors
    • Condensed About and Why sections with clearer, shorter copy.
    • Tightened Contributing and Security instructions; kept MIT license and security contact.
    • Simplified header markup and badges: inline

      , centered shields, and updated “Learn more →”.

Written for commit 31af504ffe. Summary will update on new commits.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/better-auth/better-auth/pull/8093 **Author:** [@himself65](https://github.com/himself65) **Created:** 2/22/2026 **Status:** ❌ Closed **Base:** `canary` ← **Head:** `himself65/2026/02/22/readme-rephrase` --- ### 📝 Commits (1) - [`31af504`](https://github.com/better-auth/better-auth/commit/31af504ffea895b4445d04d3309b4f5ddfae17b3) docs: rephrase README.md for conciseness ### 📊 Changes **1 file changed** (+17 additions, -22 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+17 -22) </details> ### 📄 Description This PR makes the README.md more concise by: - Condensing the "About the Project" section - Simplifying the "Why Better Auth" explanation - Tightening up the "Contributing" section - Shortening the "Security" section No content was removed, only phrasing was tightened for better readability. <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Rephrased and cleaned up README to be shorter and easier to scan, without removing content. Improves clarity in key sections and tidies header markup. - **Refactors** - Condensed About and Why sections with clearer, shorter copy. - Tightened Contributing and Security instructions; kept MIT license and security contact. - Simplified header markup and badges: inline <h2>, centered shields, and updated “Learn more →”. <sup>Written for commit 31af504ffea895b4445d04d3309b4f5ddfae17b3. Summary will update on new commits.</sup> <!-- End of auto-generated description by cubic. --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-03-13 13:47:51 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#7742