diff --git a/README.md b/README.md index 8d539c9..16a3f0e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,69 @@ -# wardenpy -cli python password manager +
+
-## First iteration -thinking that only one user would use the tool +# WardenPy -[] - Fix the autentication logic -[] - add migration logic to main inti logic -[] - fix todo and warning notations -[] - fix funtions return type to optimize the thing -[] - add colors for all the funtions +[![codecov](https://codecov.io/github/deepattic/wardenpy/graph/badge.svg?token=U6U8SOJUNW)](https://codecov.io/github/deepattic/wardenpy) +[![License](https://img.shields.io/github/license/deepattic/wardenpy)](https://github.com/deepattic/wardenpy/blob/main/LICENSE) +[![GitHub stars](https://img.shields.io/github/stars/deepattic/wardenpy)](https://github.com/deepattic/wardenpy/stargazers) +[![GitHub issues](https://img.shields.io/github/issues/deepattic/wardenpy)](https://github.com/deepattic/wardenpy/issues) +[![GitHub release](https://img.shields.io/github/v/release/deepattic/wardenpy)](https://github.com/deepattic/wardenpy/releases) + +wardenpy is a **cli-password manager**, inspired by bitwarden and 1pass. + +It uses the most modern and up-to-date hashing algorithms, such as argon 2, and encryption techniques, such as ChaCha20-Poly1305. + +| [Getting started](#getting-started) • +[Installation](#installation) | + +
+ +## Getting started + +![Tutorial][tutorial] + +Run With python : +```sh +wardenpy init [username] # Set up a SQLite database and create a new user named {username}. +wardenpy -u [username] # Login with your username +wardenpy -u [*] -p [password] # Login with your username and password. + +wardenpy export # Export all the entries of a user + +``` +## Installation + +wardenpy can be installed in these easy steps: + +1. **Manual Installation** + + wardenpy runs on most major platforms. + +
+ Linux / WSL + + > Just clone the repo and install the requirements: + > + > ```sh + > git clone --depth=1 https://www.github.com/deepattic/wardenpy + > cd wardenpy + > pip install -r requirements.txt + > ``` +
+ +
+ macOS + + > I just dont have an apple device if you have one plz consider putting a pull request :) + +
+ +
+ Windows + + > And i also dont have a windows pc if you have one plz consider putting a pull request :/ +
+ + + +[tutorial]: contrib/tutorial.webp