diff --git a/packages/abstract/README.md b/packages/abstract/README.md new file mode 100644 index 00000000..f9d2dcb2 --- /dev/null +++ b/packages/abstract/README.md @@ -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. diff --git a/packages/dom/README.md b/packages/dom/README.md new file mode 100644 index 00000000..d0dda27c --- /dev/null +++ b/packages/dom/README.md @@ -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. diff --git a/packages/eslint-config/README.md b/packages/eslint-config/README.md index 8b42d901..ebcac042 100644 --- a/packages/eslint-config/README.md +++ b/packages/eslint-config/README.md @@ -1,3 +1,3 @@ -# `@turbo/eslint-config` +# `@dnd-kit/eslint-config` Collection of internal eslint configurations. diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json index cbe3cb10..c9ea13a7 100644 --- a/packages/eslint-config/package.json +++ b/packages/eslint-config/package.json @@ -1,6 +1,6 @@ { "name": "@dnd-kit/eslint-config", - "version": "0.0.1", + "version": "0.0.0", "private": true, "files": [ "vanilla.js", diff --git a/packages/geometry/README.md b/packages/geometry/README.md new file mode 100644 index 00000000..32f53083 --- /dev/null +++ b/packages/geometry/README.md @@ -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. diff --git a/packages/helpers/README.md b/packages/helpers/README.md new file mode 100644 index 00000000..1cede95d --- /dev/null +++ b/packages/helpers/README.md @@ -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. diff --git a/packages/react/README.md b/packages/react/README.md new file mode 100644 index 00000000..e0c6053f --- /dev/null +++ b/packages/react/README.md @@ -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. diff --git a/packages/state/README.md b/packages/state/README.md new file mode 100644 index 00000000..39ef7e5a --- /dev/null +++ b/packages/state/README.md @@ -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