diff --git a/README.md b/README.md index 2988e5d682d2e9df26ea3a1787dd617db8a21a6b..e9bcc25c13962ede2210be00889309c16a16626c 100644 --- a/README.md +++ b/README.md @@ -50,20 +50,37 @@ connections: username : username password : password ``` +**Note 1**: You do not need the usernames or passwords anymore. With the current version, you are able to enter username and password directly from within a Jupyter notebook. -Now you are **ready to launch!** +**Note 2**: You can place this file in any of these directories (on Mac OS X): + +``` +/Users/your_username/jupyter-openbis-extension/notebooks +/Users/your_username/.jupyter +/Users/your_username/.pyenv/versions/3.6.0/etc/jupyter # or wherever your jupyter installation is located +/usr/local/etc/jupyter +/etc/jupyter +``` +These directories are produced by Jupyters' `nb_server_app.config_file_paths` method. + +## Launching Jupyter notebook + +Now you are **ready to launch jupyter notebook!** ``` $ jupyter notebook ``` -Observe the terminal. It should tell you that the server(s) have been successfully connected: +Observe the terminal. It should tell you which server(s) have been successfully connected (and which not): ``` $ jupyter notebook -connected to TEST local openBIS instance -connected to PRODUCTION openBIS instance +Registered: https://localhost:8443 +Cannot establish connection to: https://localhost:8443 +Registered: https://openbis.example.com +Successfully connected to: https://openbis.example.com ``` -**Congratulations!** +**Congratulations!** You can retry non-successful connections later, directly from the GUI. + ## Uninstall Jupyter extension