diff --git a/README.md b/README.md index f5dee32..cd050a8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # cscs-keygen Python script to automate fetching a new SSH keypair for CSCS infrastructure. It relies on credentials stored in a cloud-based password manager, like Bitwarden or 1Password. + +## Setup + +### Prerequisites + +- Python 3.10 with the dependencies listed in `requirements.txt` installed +- An account with a supported password manager (Bitwarden, 1Password) +- The command-line interface (CLI) of password manager of your choice +- (optional) A virtual environment with `venv` or `pipenv` (or any other similar utility of your choice) + +## Usage + +Please, check out the [docs](https://github.com/empa-scientific-it/cscs-keygen/wiki) of this project for details on the usage.