refine-sanity/README.md

Data provider for refine with sanity. refine is a React-based framework for building internal tools, rapidly. Sanity is headless CMS.

# refine-sanity

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![NPM Version](https://img.shields.io/npm/v/refine-sanity.svg)](https://www.npmjs.com/package/refine-sanity)
[![NPM Downloads](https://img.shields.io/npm/dt/refine-sanity.svg)](https://www.npmjs.com/package/refine-sanity)
![GitHub Repo stars](https://img.shields.io/github/stars/hirenf14/refine-sanity)
![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/hirenf14/refine-sanity)


![npm peer dependency version (scoped)](https://img.shields.io/npm/dependency-version/refine-sanity/peer/%40refinedev%2Fcore)
![npm peer dependency version (scoped)](https://img.shields.io/npm/dependency-version/refine-sanity/peer/%40sanity%2Fclient)
![npm (prod) dependency version (scoped)](https://img.shields.io/npm/dependency-version/refine-sanity/groqd)
![npm type definitions](https://img.shields.io/npm/types/refine-sanity)



`refine-sanity` is a data provider for [Refine](https://refine.dev/) that enables seamless integration with [Sanity](https://www.sanity.io/). It simplifies the management of your Sanity data within Refine-powered React applications.

## Installation

Install `refine-sanity` via npm or yarn:

```bash
npm install @sanity/client refine-sanity
# or
yarn add @sanity/client refine-sanity
```

## Usage

```tsx
import dataProvider from "refine-sanity";
import { createClient } from "@sanity/client";

const client = createClient({
    token: "EDITOR_SANITY_ACCESS_TOKEN",
    projectId: "SANITY_PROJECT_ID",
    dataset: "SANITY_DATASET"
});

const App = () => {
  return (
    <Refine
      dataProvider={dataProvider(client)}
      /* ... */
    >
      {/* ... */}
    </Refine>
  );
};

```


## Documentation
- For more detailed information and usage, refer to [the refine data provider documentation](https://refine.dev/docs/api-reference/core/providers/data-provider/).
- [Refer to documentation for more info about refine](https://refine.dev/docs/)
- [Step up to refine tutorials.](https://refine.dev/docs/tutorial/introduction/index/)