[PR #4961] [CLOSED] Update README.md #2678

New Issue

OVERLORD · 2025-10-09T18:09:31+03:00

OVERLORD commented

2025-10-09 18:09:31 +03:00

📋 Pull Request Information

Original PR: https://github.com/dani-garcia/vaultwarden/pull/4961
Author: @georglauterbach
Created: 9/18/2024
Status: ❌ Closed

Base: main ← Head: patch-1

📝 Commits (1)

cb74d64 Update README.md

📊 Changes

1 file changed (+40 additions, -71 deletions)

View changed files

📝 README.md (+40 -71)

📄 Description

Description

New contributor here that want to switch to Vaulwarden. I would like to help this project by improving the README a bit. While maintaining other projects on GitHub, I learned quite a lot about good documentation and the value of a proper README, and hence, I'd like to give something back and improve the README of this project.

Please have a look at what it looks like at the moment.

Please tell me if you think I removed something that was not supposed to be removed.**

Details

Updated the heading (was too verbose)
Removed superflous links from the badges list
Pulled text together to make the text easier to read (it was too scattered, making it hard to read)
added proper GitHub Markdown alerts to make notes and important messages stand out (instead of just using bold text)
Added articles where necessary
Added a link to the Helm chart for installations in Kubernets clusters
Updated the command for running the image with Docker
- The command is for testing purposed, i.e. there is no need to restart anything or detach (you actually want to see the log)
- The container can be removed once stopped; since the data is persisted, there is no issue at all
updated headings to make them uniform (especially the level)
removed HTML and converted to pure Markdown, which is preffered in Markdown

_{🔄 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/dani-garcia/vaultwarden/pull/4961 **Author:** [@georglauterbach](https://github.com/georglauterbach) **Created:** 9/18/2024 **Status:** ❌ Closed **Base:** `main` ← **Head:** `patch-1` --- ### 📝 Commits (1) - [`cb74d64`](https://github.com/dani-garcia/vaultwarden/commit/cb74d64b8108c4db33024cf519a6d24dc713f2c9) Update README.md ### 📊 Changes **1 file changed** (+40 additions, -71 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+40 -71) </details> ### 📄 Description ## Description New contributor here that want to switch to Vaulwarden. I would like to help this project by improving the README a bit. While maintaining [other projects on GitHub](https://github.com/docker-mailserver/docker-mailserver), I learned quite a lot about good documentation and the value of a proper README, and hence, I'd like to give something back and improve the README of this project. Please have a look at [what it looks like at the moment](https://github.com/georglauterbach/vaultwarden/tree/patch-1). Please tell me if you think I removed something that was not supposed to be removed.** ## Details - Updated the heading (was too verbose) - Removed superflous links from the badges list - Pulled text together to make the text easier to read (it was too scattered, making it hard to read) - added proper [GitHub Markdown alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) to make notes and important messages stand out (instead of just using bold text) - Added articles where necessary - Added a link to the Helm chart for installations in Kubernets clusters - Updated the command for running the image with Docker - The command is for testing purposed, i.e. there is no need to restart anything or detach (you actually want to see the log) - The container can be removed once stopped; since the data is persisted, there is no issue at all - updated headings to make them uniform (especially the level) - removed HTML and converted to pure Markdown, which is preffered in Markdown --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

OVERLORD added the pull-request label 2025-10-09 18:09:31 +03:00

OVERLORD closed this issue

2025-10-09 18:09:33 +03:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/vaultwarden#2678

[PR #4961] [CLOSED] Update README.md #2678