From a921776b4cc2da4ec2892872b3a3ce74e8b8ad0c Mon Sep 17 00:00:00 2001 From: Snorre Eskeland Brekke Date: Mon, 4 Dec 2023 15:21:41 +0100 Subject: [PATCH] chore: fix readme --- README.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 1d5eca0..fbf353d 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,7 @@ -> This is a **Sanity Studio v3** plugin. - -## Installation - -```sh -npm install @sanity/hierarchical-document-list -``` - -## Usage - # sanity-plugin-hierarchical-document-list +> This is a **Sanity Studio v3** plugin. + Plugin for visually organizing documents as hierarchies in the [Sanity studio](https://www.sanity.io/docs/sanity-studio). Applications include: - Tables of content - such as a book's sections and chapters @@ -22,13 +14,16 @@ Plugin for visually organizing documents as hierarchies in the [Sanity studio](h If you're looking for a way to order documents on a flat list, refer to [@sanity/orderable-document-list](https://github.com/sanity-io/orderable-document-list). -## Getting started + +## Installation + ```bash # From the root of your sanity project sanity install @sanity/hierarchical-document-list ``` -Once you've installed the plugin the next steps are: + +## Usage ### 1. Add the plugin and the default documentType to the sanity.config.ts