Skip to content
Snippets Groups Projects

Document newly added features in README

Merged Sören Ducati requested to merge ducati/2fa:master into master
1 file
+ 12
2
Compare changes
  • Side-by-side
  • Inline
+ 12
2
@@ -14,7 +14,7 @@ source venv/bin/activate
pip install -r requirements.txt
```
## Enrollment
## Enrollment of secret
Launch a Python shell, e.g., using:
@@ -23,7 +23,7 @@ source venv/bin/activate
python3 main.py -e
```
This will only store the token locally in the secret storage, with minimal validation.
This will only store the secret locally in the secret storage, with minimal validation.
To facilitate scripting, you can also pass the token as a quoted (!) string to the script, i.e like that:
```bash
@@ -37,6 +37,16 @@ source venv/bin/activate
./main.py
```
## Deletion of secret
If you ever want to delete the token, just call the script with the `-d` argument:
⚠️ there is no confirmation of the deletion, it will just delete the token!
```bash
python3 main.py -d
```
## License
This "project" is licensed under [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/), i.e., released to the public domain. TL;DR: You can do whatever the fuck you want to with this code, but don't hold me liable if something bad happens.
Loading