Skip to content

Commit

Permalink
Add readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
clauderic committed Jun 3, 2024
1 parent 5d96fe0 commit 42baaa1
Show file tree
Hide file tree
Showing 8 changed files with 80 additions and 2 deletions.
7 changes: 7 additions & 0 deletions packages/abstract/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# @dnd-kit/abstract

[![Stable release](https://img.shields.io/npm/v/@dnd-kit/abstract.svg)](https://npm.im/@dnd-kit/abstract)

Abstract implementation of @dnd-kit, which can be extended by concrete implementation layers, such as @dnd-kit/dom.

This package is not meant to be used by most consumers, unless you are planning on building a concrete implementation layer on top of @dnd-kit.
17 changes: 17 additions & 0 deletions packages/dom/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# @dnd-kit/dom

[![Stable release](https://img.shields.io/npm/v/@dnd-kit/dom.svg)](https://npm.im/@dnd-kit/dom)

The DOM implementation layer for @dnd-kit, built on top of @dnd-kit/abstract

## Installation

To get started, install the `@dnd-kit/dom` package via npm or yarn:

```
npm install @dnd-kit/dom
```

## Usage

Visit [docs.dndkit.com](https://docs.dndkit.com) to learn how to get started with @dnd-kit.
2 changes: 1 addition & 1 deletion packages/eslint-config/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# `@turbo/eslint-config`
# `@dnd-kit/eslint-config`

Collection of internal eslint configurations.
2 changes: 1 addition & 1 deletion packages/eslint-config/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@dnd-kit/eslint-config",
"version": "0.0.1",
"version": "0.0.0",
"private": true,
"files": [
"vanilla.js",
Expand Down
15 changes: 15 additions & 0 deletions packages/geometry/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# @dnd-kit/geometry

[![Stable release](https://img.shields.io/npm/v/@dnd-kit/geometry.svg)](https://npm.im/@dnd-kit/geometry)

## Installation

To get started, install the `@dnd-kit/geometry` package via npm or yarn:

```
npm install @dnd-kit/geometry
```

## Usage

Visit [docs.dndkit.com](https://docs.dndkit.com) to learn how to get started with @dnd-kit.
17 changes: 17 additions & 0 deletions packages/helpers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# @dnd-kit/helpers

[![Stable release](https://img.shields.io/npm/v/@dnd-kit/helpers.svg)](https://npm.im/@dnd-kit/helpers)

Helpers for working with @dnd-kit.

## Installation

To get started, install the `@dnd-kit/helpers` package via npm or yarn:

```
npm install @dnd-kit/helpers
```

## Usage

Visit [docs.dndkit.com](https://docs.dndkit.com) to learn how to get started with @dnd-kit.
17 changes: 17 additions & 0 deletions packages/react/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# @dnd-kit/react

[![Stable release](https://img.shields.io/npm/v/@dnd-kit/react.svg)](https://npm.im/@dnd-kit/react)

The React layer for @dnd-kit, built on top of @dnd-kit/dom.

## Installation

To get started, install the `@dnd-kit/react` package via npm or yarn:

```
npm install @dnd-kit/react
```

## Usage

Visit [docs.dndkit.com](https://docs.dndkit.com) to learn how to get started with @dnd-kit.
5 changes: 5 additions & 0 deletions packages/state/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# @dnd-kit/state

[![Stable release](https://img.shields.io/npm/v/@dnd-kit/state.svg)](https://npm.im/@dnd-kit/state)

Internal state management library for @dnd-kit

0 comments on commit 42baaa1

Please sign in to comment.