From 40f13c3f0ceb004560e94d99b4ccc835b9f52360 Mon Sep 17 00:00:00 2001 From: Ines Montani Date: Thu, 24 Jun 2021 11:57:15 +1000 Subject: [PATCH] Add docs [ci skip] --- website/docs/api/cli.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/website/docs/api/cli.md b/website/docs/api/cli.md index 685f998ff..5dfe567b3 100644 --- a/website/docs/api/cli.md +++ b/website/docs/api/cli.md @@ -933,7 +933,10 @@ copied into the package and imported in the `__init__.py`. If the path to a [`meta.json`](/api/data-formats#meta) is supplied, or a `meta.json` is found in the input directory, this file is used. Otherwise, the data can be entered directly from the command line. spaCy will then create a build artifact that you -can distribute and install with `pip install`. +can distribute and install with `pip install`. As of v3.1, the `package` command +will also create a formatted `README.md` based on the pipeline information +defined in the `meta.json`. If a `README.md` is already present in the source +directory, it will be used instead.