Skip to content

Commit

Permalink
chore: fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
snorrees authored Dec 4, 2023
1 parent e3607a3 commit a921776
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand Down

0 comments on commit a921776

Please sign in to comment.