docs: update readme installation and add api docs

Mirascope · Apr 17, 2024 · 7b77e5e · 7b77e5e
1 parent 608fd1f
commit 7b77e5e
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 2 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -13,8 +13,8 @@ pip install mirascope-cli
 If you're using the `mirascope` package, you can also install the CLI as an extra dependency:
 
 ```shell
-pip install mirascope[mirascope-cli]  # just the mirascope-cli
-pip install mirascope[all]            # all optional dependencies
+pip install mirascope[cli]  # just the mirascope-cli
+pip install mirascope[all]  # all optional dependencies
 ```
 
 ## The prompt management environment

diff --git a/docs/api/commands.md b/docs/api/commands.md
@@ -0,0 +1,3 @@
+# cli.commands
+
+::: mirascope.cli.commands
diff --git a/docs/api/constants.md b/docs/api/constants.md
@@ -0,0 +1,3 @@
+# cli.constants
+
+::: mirascope.cli.constants
diff --git a/docs/api/generic.md b/docs/api/generic.md
@@ -0,0 +1,3 @@
+# cli.generic
+
+::: mirascope.cli.generic
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -0,0 +1,3 @@
+# cli
+
+::: mirascope.cli
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -0,0 +1,3 @@
+# cli.schemas
+
+::: mirascope.cli.schemas
diff --git a/docs/api/utils.md b/docs/api/utils.md
@@ -0,0 +1,3 @@
+# cli.utils
+
+::: mirascope.cli.utils