diff --git a/README.md b/README.md index 17edda82..e89ba213 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ +This is Bitwarden server API implementation written in rust compatible with [upstream Bitwarden clients](https://bitwarden.com/#download)*, ideal for self-hosted deployment where running official resource-heavy service might not be ideal. + +Image is based on [Rust implementation of Bitwarden API](https://github.com/dani-garcia/bitwarden_rs). + +_*Note, that this project is not associated with the [Bitwarden](https://bitwarden.com/) project nor 8bit Solutions LLC._ + +## Features + +Basically full implementation of Bitwarden API is provided including: + + * Basic single user functionality + * Organizations support + * Attachments + * Vault API support + * Serving the static files for Vault interface + * Website icons API + ## Docker image usage ### Starting a container