Add cli desc.

lfwa · Aug 25, 2024 · f48cfe9 · f48cfe9
1 parent 04b4f36
commit f48cfe9
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -31,6 +31,13 @@ pip install carbontracker
 
 ## Basic usage
 
+### Command Line Mode
+Wrap any of your scripts (python, bash, etc.):
+
+`carbontracker python script.py
+`
+### Embed into Python Scripts
+
 #### Required arguments
 - `epochs`:
   Total epochs of your training loop.