Skip to content

Commit

Permalink
WIP: Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BlackDex committed Oct 30, 2024
1 parent 33bae5f commit 4b30ece
Show file tree
Hide file tree
Showing 2 changed files with 95 additions and 42 deletions.
59 changes: 17 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -20,6 +20,9 @@ Image is based on [Rust implementation of Bitwarden API](https://github.com/dani

---

> [!NOTE]Note<br>
> Testing
## Features

Basically full implementation of Bitwarden API is provided including:
Expand Down Expand Up @@ -58,45 +61,17 @@ 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
<br>

### Contributors
Thanks for your contribution to the project!

<!--
<table>
<tr>
<td align="center">
<a href="https://github.com/username">
<img src="https://avatars.githubusercontent.com/u/725423?s=75&v=4" width="75px;" alt="username"/>
<br />
<sub><b>username</b></sub>
</a>
</td>
</tr>
</table>
<br/>
-->

<table>
<tr>
<td align="center">
<a href="https://github.com/themightychris" style="width: 75px">
<sub><b>Chris Alfano</b></sub>
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/numberly" style="width: 75px">
<sub><b>Numberly</b></sub>
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/IQ333777" style="width: 75px">
<sub><b>IQ333777</b></sub>
</a>
</td>
</tr>
</table>
<a href="https://github.com/dani-garcia/vaultwarden/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=dani-garcia/vaultwarden" width="800"/>
</a>

<br><br>

> [!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.<br>
> Please see [#1642 - 1.21.0 release and project rename to Vaultwarden](https://github.com/dani-garcia/vaultwarden/discussions/1642) for more explanation.
78 changes: 78 additions & 0 deletions resources/vaultwarden-logo-auto.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4b30ece

Please sign in to comment.