diff --git a/README.md b/README.md index 4378fd8..eb9e3e1 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ ColabCode also has a command-line script. So you can just run `colabcode` from c `colabcode -h` will give the following: ``` -usage: colabcode [-h] --port PORT [--password PASSWORD] [--mount_drive] +usage: colabcode [-h] --port PORT [--password PASSWORD] [--mount_drive] [--option OPTION] ColabCode: Run VS Code On Colab / Kaggle Notebooks @@ -33,6 +33,7 @@ required arguments: optional arguments: --password PASSWORD password to protect your code-server from unauthorized access --mount_drive if you use --mount_drive, your google drive will be mounted + --option choose between "localtunnel" and "ngrok" for tunneling services ``` Else, you can do the following: @@ -50,8 +51,9 @@ $ ColabCode() # - port: the port you want to run code-server on, default 10000 # - password: password to protect your code server from being accessed by someone else. Note that there is no password by default! # - mount_drive: True or False to mount your Google Drive +# - option: "localtunnel" or "ngrok" to use respective tunneling services -$ ColabCode(port=10000, password="abhishek", mount_drive=True) +$ ColabCode(port=10000, password="abhishek", mount_drive=True, option="localtunnel") ``` ## How to use it? Colab starter notebook: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/abhishekkrthakur/colabcode/blob/master/colab_starter.ipynb)