From 6dd6f461dc3152d00d38743aafa29afa4d248345 Mon Sep 17 00:00:00 2001
From: Ramon Brullo <kingvanti650@gmail.com>
Date: Fri, 1 Nov 2024 20:17:24 +0100
Subject: [PATCH] add docs

---
 README.md      | 10 ++++++++++
 docs/cmd-ls.md | 18 ++++++++++++++++++
 2 files changed, 28 insertions(+)
 create mode 100644 docs/cmd-ls.md

diff --git a/README.md b/README.md
index 89b84ed0..91089e5e 100644
--- a/README.md
+++ b/README.md
@@ -118,6 +118,16 @@ openupm deps com.my.package
 
 Checkout [the commands doc page](./docs/cmd-deps.md) for more information.
 
+### List installed packages
+
+Use `openupm ls` to print the names and versions of installed packages.
+
+```sh
+openupm ls
+```
+
+Checkout [the commands doc page](./docs/cmd-ls.md) for more information.
+
 ### Global command options
 
 There are also some global options that work for every command. You can read about them [here](./docs/global-opts.md).
diff --git a/docs/cmd-ls.md b/docs/cmd-ls.md
new file mode 100644
index 00000000..c9eb3839
--- /dev/null
+++ b/docs/cmd-ls.md
@@ -0,0 +1,18 @@
+
+# `openupm ls`
+
+The `ls` command prints the name and version of each installed package for a project.
+
+This command has the `list` alias. On this doc page we will always use the primary command name `ls`.
+
+## Options
+
+### Project directory
+
+By default openupm expects that you run the add command inside your Unity projects root directory. Based on this it determines relative paths to your package manifest etc.
+
+If you need to run openupm from somewhere else you can change the working directory using the `--chdir`/`-c` option. This option accepts an **absolute** path to a Unity projects root directory.
+
+```sh
+openupm add com.my.package -c /home/user/dev/MyProject
+```
\ No newline at end of file