Update descriptions. (#41)

kubernetes-sigs · Jan 17, 2025 · 2fd97ba · 2fd97ba
1 parent ed95162
commit 2fd97ba
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,12 @@
 # kjob
 
-KJob: Tool for CLI-loving ML researchers
+Run AI/ML jobs based on the pre-defined templates
 
 ## Description
-The `kubectl-kjob` plugin, `kjobctl`, allows you to list, describe and create jobs.
+This kubectl plugin allows ML researchers to run templated Jobs with different values
+for the application-specific parameters, without the need to edit and submit entire
+YAML files. The tool comes with built-in support for running slurm scripts inside
+a Kubernetes cluster.
 
 Read the [overview](docs/_index.md) to learn more.
 

diff --git a/docs/_index.md b/docs/_index.md
@@ -1,6 +1,9 @@
 # Kubectl Kjob Plugin
 
-The `kubectl-kjob` plugin, `kjobctl`, allows you to list, describe and create jobs.
+This kubectl plugin allows ML researchers to run templated Jobs with different values
+for the application-specific parameters, without the need to edit and submit entire
+YAML files. The tool comes with built-in support for running slurm scripts inside
+a Kubernetes cluster.
 
 ## Syntax