Explorar o código

Add instructions for using the package

Sean %!s(int64=4) %!d(string=hai) anos
pai
achega
362a91a34a
Modificáronse 1 ficheiros con 8 adicións e 2 borrados
  1. 8 2
      readme.md

+ 8 - 2
readme.md

@@ -6,6 +6,12 @@ openconnect VPN client.
 It uses selenium to open the login webpage and fill in the form details. At the end, it
 fetches the correct VPN HOST and the Cisco AnyConnect `webvpn` cookie.
 
+## Installation for CLI usage
+
+Simply run `pip install git+https://git.snas.black-burn.ch/FHNW/openconnect-ms-auth` to
+install the package globally. Then the "ocma" command should be available. Try it out by
+typing `ocma -h`.
+
 ## Example CLI usage
 
 Replace `[username]` and `[password]` with your own information. If you have your account
@@ -15,11 +21,11 @@ Example of a TOTP url: `otpauth://totp/FHNW%3Aelon.musk%40students.fhnw.ch?secre
 The secret in this case would be `NBSWY3DPEB3W64TMMQ`. This needs to be provided as an input.
 
 ```shell
-eval $( python ocma/cli.py -u [username] -p [password] -m [mfa_secret] --print-to-stdout );
+eval $( ocma -u [username] -p [password] -m [mfa_secret] --print-to-stdout );
 [ -n $VPN_COOKIE ] && echo $VPN_COOKIE | sudo openconnect --cookie-on-stdin $VPN_HOST
 ```
 
-## Example usage Python
+## Example usage in a Python project
 
 Add with poetry: `poetry add git+https://git.snas.black-burn.ch/FHNW/openconnect-ms-auth`