Update README.md #933

New Issue

MrUnknownDE · 2026-04-06T01:04:16+02:00

MrUnknownDE commented

2026-04-06 01:04:16 +02:00

Originally created by @georglauterbach on 9/18/2024

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

*Originally created by @georglauterbach on 9/18/2024* ## 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

MrUnknownDE closed this issue

2026-04-06 01:04:16 +02:00

Sign in to join this conversation.

No Label

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/vaultwarden#933

Update README.md #933

Description

Details

Update `README.md` #933