From 51152603666fb34eb5679da66d856dcc01c78536 Mon Sep 17 00:00:00 2001
From: Michael Angerman <1809991+stormasm@users.noreply.github.com>
Date: Wed, 19 Jul 2023 21:35:58 -0700
Subject: [PATCH] add in a Readme for the crate nu-cmd-extra (#9745)

This outlines our plans for the commands located in the crate
nu-cmd-extra.

It also documents how one can build these commands from source.
---
 crates/nu-cmd-extra/README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 crates/nu-cmd-extra/README.md

diff --git a/crates/nu-cmd-extra/README.md b/crates/nu-cmd-extra/README.md
new file mode 100644
index 0000000000..096d7ff711
--- /dev/null
+++ b/crates/nu-cmd-extra/README.md
@@ -0,0 +1,30 @@
+# nu-cmd-extra
+
+## the extra commands are not part of the Nushell binary
+
+The commands in this crate are the *extra commands* of Nushell.  They do not
+get built for the release and it is the responsibility of the developer to
+build these commands if they want to use them.
+
+These commands are not going to part of the 1.0 Api; meaning that there
+is no guarantee longer term that these commands will be around into the future.
+Of course since they are part of the source tree one could always incorporate
+them into their own custom release.
+
+### How to build the commands in this crate
+
+Step 1 is to
+[read the installation notes](https://www.nushell.sh/book/installation.html#build-from-source)
+for Nushell which is located in our Nushell book.
+
+Once Rust is installed you can then build Nushell with the following command.
+
+```rust
+cargo build --features=extra
+```
+
+Your Nushell binary which just got built is called *nu* and will be located here.
+
+```
+nushell/target/debug/nu
+```