added basic use in the readme

Kapoorlabs-paris · Jan 7, 2022 · 1289cde · 1289cde
1 parent d226fed
commit 1289cde
Showing 1 changed file with 16 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -19,4 +19,19 @@ cd jz-hydra-submitit-launcher
 pip install .
 ```
 
-## Use
+## Use
+
+The primary use is with the `hydra-submitit-launch` command with your script name and the config type:
+```
+hydra-submitit-launch my_app.py dev
+```
+
+## Available configs
+
+## Advanced use
+
+
+## References
+- Hydra: https://hydra.cc/docs/intro/
+- submitit-launcher: https://hydra.cc/docs/plugins/submitit_launcher/
+- submitit: https://github.com/facebookincubator/submitit