Improvements to README.md. Also closes #4901 #4930 #4931
Conversation
yonas
force-pushed
the
yonas-patch-readme-improvements
branch
from
28ca487
to
cb98119
Compare
yonas
changed the title
Various improvements to the README.md
yonas
force-pushed
the
yonas-patch-readme-improvements
branch
from
73250eb
to
3eda1dd
Compare
| [](https://github.com/dani-garcia/vaultwarden/actions/workflows/build.yml) | ||
| [](https://github.com/dani-garcia/vaultwarden/pkgs/container/vaultwarden) | ||
| [](https://github.com/dani-garcia/vaultwarden/pkgs/container/vaultwarden) |
There was a problem hiding this comment.
I'm not a fan of including changes from an active PR.
| > [!TIP] | ||
| > [Please report any bugs or suggestions to us directly](#get-in-touch), regardless of whatever clients you are using (mobile, desktop, browser...). | ||
| > | ||
| > Do not use the official support channels. |
There was a problem hiding this comment.
Why the line break? The "official support channels" refer to Bitwarden support channels which is lost if you break up the paragraph like this. So please clarify what is meant by that or keep it in the same paragraph.
|
|
||
| --- | ||
|
|
||
| ## Features | ||
|
|
||
| Basically full implementation of Bitwarden API is provided including: | ||
| A full implementation of the Bitwarden API: |
There was a problem hiding this comment.
Vaultwarden does not implement the full Bitwarden API. It notably is missing the Bitwarden Public API as stated in the wiki, so the qualifier should remain or better the sentence should be clarified what is meant.
| * Authenticator and U2F support | ||
| * YubiKey and Duo support | ||
| * Organizations | ||
| * Attachments and send |
There was a problem hiding this comment.
Bitwarden Send is a product name so this should arguably stay capitalized.
| * Organizations | ||
| * Attachments and send | ||
| * Vault API | ||
| * Serving static files |
There was a problem hiding this comment.
I think the important part would be that the server comes bundled with a modified version of the Bitwarden web-vault not that Vaultwarden serves static files.
|
|
||
| ## Get in touch | ||
| ## Get in touch ☕ | ||
| ### Discussions |
There was a problem hiding this comment.
Not a fan of these sub headlines.
| To ask a question, offer suggestions or new features or to get help configuring or installing the software, please use [GitHub Discussions](https://github.com/dani-garcia/vaultwarden/discussions) or [the forum](https://vaultwarden.discourse.group/). | ||
|
|
||
| ### Issues |
There was a problem hiding this comment.
This should probably say "Bug reports" instead of "Issues" as common support questions and configuration issues should be asked in Github discussions or our Discourse forum (but like I said I'd rather not have these sub headlines in the first place.)
| Alternative implementation of the Bitwarden server API written in Rust and compatible with [upstream Bitwarden clients](https://bitwarden.com/download/). | ||
|
|
||
| Vaultwarden is the perfect self-hosted solution when running the official service is too resource-heavy. |
There was a problem hiding this comment.
I think I'd prefer the description from the wiki. Maybe we should even include the sentence regarding the target audience.
| Alternative implementation of the Bitwarden server API written in Rust and compatible with [upstream Bitwarden clients](https://bitwarden.com/download/). | |
| Vaultwarden is the perfect self-hosted solution when running the official service is too resource-heavy. | |
| Vaultwarden is an unofficial Bitwarden server implementation written in Rust that is targeted towards individuals, families and smaller organizations. It is compatible with the [official Bitwarden clients](https://bitwarden.com/download/). | |
| Vaultwarden is ideal for self-hosted deployments where running the official resource-heavy service would be undesirable. |
|
|
||
| #### ⚠️**IMPORTANT**⚠️: When using this server, please report any bugs or suggestions to us directly (look at the bottom of this page for ways to get in touch), regardless of whatever clients you are using (mobile, desktop, browser...). DO NOT use the official support channels. | ||
| > [!TIP] | ||
| > [Please report any bugs or suggestions to us directly](#get-in-touch), regardless of whatever clients you are using (mobile, desktop, browser...). |
There was a problem hiding this comment.
The link does not work because you have added a space and an emoji below.
|
|
||
| ## Get in touch | ||
| ## Get in touch ☕ |
There was a problem hiding this comment.
The fragment identifier would change to #get-in-touch-, so we might not want to change the heading because of that.
Various improvements to the README.md
PRs closed by this PR