diff --git a/README.md b/README.md index c352df22112..4be95beb9f9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -### Alternative implementation of the Bitwarden server API written in Rust and compatible with [upstream Bitwarden clients](https://bitwarden.com/download/)*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal. +# ![Vaultwarden](./resources/vaultwarden-logo-auto.svg) -📢 Note: This project was known as Bitwarden_RS and has been renamed to separate itself from the official Bitwarden server in the hopes of avoiding confusion and trademark/branding issues. Please see [#1642](https://github.com/dani-garcia/vaultwarden/discussions/1642) for more explanation. +An alternative server implementation of the Bitwarden Client API written in Rust and compatible with [upstream Bitwarden clients](https://bitwarden.com/download/)*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal. --- [![Build](https://github.com/dani-garcia/vaultwarden/actions/workflows/build.yml/badge.svg)](https://github.com/dani-garcia/vaultwarden/actions/workflows/build.yml) @@ -14,12 +14,15 @@ Image is based on [Rust implementation of Bitwarden API](https://github.com/dani-garcia/vaultwarden). -**This project is not associated with the [Bitwarden](https://bitwarden.com/) project nor Bitwarden, Inc.** + #### ⚠️**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. --- +> [!NOTE] Notes +> Testing + ## Features Basically full implementation of Bitwarden API is provided including: @@ -58,45 +61,27 @@ If you spot any bugs or crashes with vaultwarden itself, please [create an issue If you prefer to chat, we're usually hanging around at [#vaultwarden:matrix.org](https://matrix.to/#/#vaultwarden:matrix.org) room on Matrix. Feel free to join us! -### Sponsors +
+ +### Contributors Thanks for your contribution to the project! - - - - - - - - - - - - -
- - Chris Alfano - -
- - Numberly - -
- - IQ333777 - -
+[![Contributors](https://contributors-img.web.app/image?repo=dani-garcia/vaultwarden "Contributors")](https://github.com/dani-garcia/vaultwarden/graphs/contributors) + +
+ +## Disclaimer + +**This project is not associated with the [Bitwarden](https://bitwarden.com/) project nor Bitwarden, Inc.** + +However, one of the active maintainers for Vaultwarden is employed by Bitwarden and he is allowed to contributing to the project. Contributions from this maintainer are reviewed by other maintainers. + +The maintainers work together on setting the direction for the project. The underlying principle is to serve the community of self-hosters, while having a sustainable project. + +
+ +## Bitwarden_RS + +This project was known as Bitwarden_RS and has been renamed to separate itself from the official Bitwarden server in the hopes of avoiding confusion and trademark/branding issues.
+Please see [#1642 - v1.21.0 release and project rename to Vaultwarden](https://github.com/dani-garcia/vaultwarden/discussions/1642) for more explanation. + diff --git a/resources/vaultwarden-logo-auto.svg b/resources/vaultwarden-logo-auto.svg new file mode 100644 index 00000000000..99f788c7d68 --- /dev/null +++ b/resources/vaultwarden-logo-auto.svg @@ -0,0 +1,78 @@ + + +Vaultwarden Logo + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +