~cyborg/yoshi

daac06a7063cce8ddd6fac99b5fada8a69503f0a — christian-cleberg 2 months ago ed98cf5
update README
1 files changed, 8 insertions(+), 7 deletions(-)

M README.md
M README.md => README.md +8 -7
@@ 1,10 1,11 @@
# CLI Password Manager
# Yoshi: A Password Manager

A simple Python CLI tool to manage accounts and generate random passwords containing ASCII letters, numbers, and
punctuation. Passwords must be at least eight (8) characters.
A simple command-line pass manager, writtin in Python + SQLite3. This tool allows you to manage accounts and generate
random passwords containing ASCII letters, numbers, and punctuation (min. 8 characters) or XKCD-like passphrases (min. 3
words).

Please note that the script is written in Python 3 - you may need to run the script with the `python3` command instead
of `python`. See the commands below for more information.
of `python` if your system uses a default of Python 2. See the Installation & Usage sections below for more information.

# Table of Contents



@@ 20,11 21,11 @@ of `python`. See the commands below for more information.
To run the script locally, run the following commands:

```bash
git clone https://github.com/christian-cleberg/cli-password-manager
git clone https://github.com/christian-cleberg/yoshi
```

```bash
cd cli-password-manager
cd yoshi
```

```bash


@@ 40,7 41,7 @@ python3 main.py --help
[(Back to top)](#table-of-contents)

All commands can be passed to the program with the following template:  
`python3 main.py <COMMAND>`
`python3 main.py <COMMAND> <FLAG> <PARAMETER>`

## Arguments