Skip to content

Commit

Permalink
Update README.md for project specs
Browse files Browse the repository at this point in the history
  • Loading branch information
lewmilburn authored Oct 19, 2023
1 parent 3af8aa2 commit 16ed428
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
# Vault
A password manager for privacy and security conscious users.

Project supervisor: Dr Shaymaa Al-Juboori

[![SonarCloud analysis](https://github.com/lewmilburn/Vault/actions/workflows/sonarcloud.yml/badge.svg)](https://github.com/lewmilburn/Vault/actions/workflows/sonarcloud.yml)

## Project Vision
The product is for security-conscious users who are worried about the possibility of a breach in a password management system they do not control, such events like this have happened in the past such as LastPass’s breach in. The Vault product is a free and easy to use password manager/vault that can be self-hosted on a web server or ran on a local machine to store and view passwords. The system can be run on a webserver or a local machine offline to help mitigate against attacks, which have become more common against major password management companies.

The project will be developed in two parts, a JavaScript-based offline/syncable application and a PHP-JavaScript web-based application for users who prefer to use the cloud.

## Developer Documentation and User Guide
https://github.com/lewmilburn/Vault/wiki

Expand Down

0 comments on commit 16ed428

Please sign in to comment.