> For the complete documentation index, see [llms.txt](https://docs.hatsprotocol.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hatsprotocol.xyz/for-developers/v1-sdk/hat-details.md).

# Hat Details

## Overview

In Hats Protocol, each hat includes a [details field](https://github.com/Hats-Protocol/hats-protocol/blob/cccb71a061cdb9095af7d11dfdb47026993d8c4e/src/Hats.sol#L67), which is used for arbitrary metadata about the hat, such as a name, description, and other properties like authorities and responsibilities associated with the hat.

A common way to use this field is to store the data on IPFS as a JSON object, and set the hat's details field with the object's CID (Content Identifier). This method allows to add rich metadata about a hat, while keeping the gas costs minimal. 

This package provides utility function to handle hats details, by both pinning metadata JSON objects to IPFS and reading from it. 

It was designed to work both in the browser and in Node.js. You can find the source code [here](https://github.com/Hats-Protocol/details-sdk).

## Content

{% content-ref url="/pages/2E9u7UIiBanGK41U1E5i" %}
[Getting Started](/for-developers/v1-sdk/hat-details/getting-started.md)
{% endcontent-ref %}

{% content-ref url="/pages/dBaW56nk5CQEb4oIYRcW" %}
[Usage](/for-developers/v1-sdk/hat-details/usage.md)
{% endcontent-ref %}