From 8700629118294bfb7bc0773ed349798d1a84b2bb Mon Sep 17 00:00:00 2001 From: Chris Turner Date: Fri, 21 May 2021 17:02:11 -0500 Subject: [PATCH] add rudimentary client config to README --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e5177d3..4662b07 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,21 @@ This is an official DataJoint Python plugin for connection to DJNeuro's hosted i Note: This plugin adds features to the `datajoint` package and thus requires it. Users should not import directly from the plugin but instead simply `import datajoint` to access plugin features. +## Client Usage + +The plugin enables connections to hosted instances by adding support +for a 'hub:' URL scheme to look up database hosts. To configure, simply +install datajoint, the plugin, and set the host URL accordingly. From +here, the plugin will intercept hosts specified using the 'hub://' +URL scheme and connect to the corresponding database. + +``` +$ pip install datajoint +$ pip install datajoint-connection-hub +$ export DJ_HOST=hub://djhub.io// +``` + + ## Run tests locally ``` @@ -15,4 +30,4 @@ $$ exit $ ./serve.sh down LOCAL ``` -Note: Make sure to have a valid Git SSH key to access necessary private repos. \ No newline at end of file +Note: Make sure to have a valid Git SSH key to access necessary private repos.