chore: Added licence, changelog, readme & security docs and updated package.json

Author: odiffey

.markdownlint.json

@@ -0,0 +1,5 @@
+{
+    "MD013": {
+        "tables": false
+    }
+}

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## [v0.1.0] - 2022-08-21
+
+Please refer to the [README](README.md) for documentation on
+how to install and use vue-draggable-list.

LICENCE

@@ -1 +1,76 @@
 # vue-draggable-list
+
+[npm](https://www.npmjs.com/package/vue-draggable-list)
+
+vue-draggable-list is a vue drag and drop component utilising [mobile-drag-drop](https://github.com/timruffles/mobile-drag-drop).
+
+Originally created for [Musare](https://github.com/Musare/Musare).
+
+## Dependencies
+
+- Vue 3
+- NodeJS v16+
+
+## Installation
+
+1. Install the package
+
+    ```bash
+    npm install vue-draggable-list
+    ```
+
+2. Import styling in to your package globally
+
+    ```javascript
+    @import "vue-draggable-list/dist/style.css";
+    ```
+
+3. Import component
+
+    ```javascript
+    import { DraggableList } from "vue-draggable-list";
+    ```
+
+4. Use the component
+
+    ```javascript
+    <draggable-list
+        item-key="_id"
+        v-model:list="myList"
+        :attributes="{
+            class: element => ({
+                'left': element.left
+            }),
+            title: 'Title'
+        }"
+        tag="div"
+        group="myGroup"
+        :disabled="isListDisabled()"
+        @start="drag = true"
+        @end="drag = false"
+        @update="updateList"
+    >
+        <template #item="{ element, index }">
+            <my-element :data="element" :index="index" />
+        </template>
+    </draggable-list>
+    ```
+
+### Props
+
+| Name | Type | Default | Optional | Description |
+| --- | --- | --- | --- | --- |
+| itemKey | String | | No | Name of the property that is unique in each list item. |
+| list | Array | | No | List of items, if defined as a v-model any updates will be applied to provided list. |
+| attributes | Object | | Yes | Object of functions or attributes of any type that will be called or applied to each item and added as an attribute. |
+| tag | String | `div` | Yes | Name of the HTML element of each item. |
+| group | String | | Yes | Name of the group, so you can move items between different lists in the same group. Leaving it empty will disable moving between lists. |
+| disabled | Boolean or Function | `false` | Yes | Used to disable dragging inside a list in general, or with a function you can prevent specific items from being dragged. |
+
+### Emits
+
+| Name | Data | Description |
+| --- | --- | --- |
+| start | | Emitted when dragging starts. |
+| end | | Emitted when dragging stops. |
+| update | `{ moved: { oldIndex: Number, newIndex: Number, updatedList: Array }` | Emitted when an element is dropped in the same list, which returns the old and new index and the new list of items. |

README.md

@@ -0,0 +1,17 @@
+# Security Policy
+
+## Supported Versions
+
+Only the latest published production version is supported.
+
+## Reporting a Vulnerability
+
+To report a vulnerability with a supported version please get in touch with us
+via email at [[email protected]](mailto:[email protected]).
+
+We endeavour to respond to reports as soon as possible, this may however take a
+few days. Please refrain from reporting security issues in public forums such as
+GitHub issues.
+
+Reports will be disclosed via a security advisory once fixes are included in a
+production release.

SECURITY.md

@@ -1,7 +1,27 @@
 {
   "name": "vue-draggable-list",
-  "version": "1.0.0",
+  "description": "vue draggable list",
+  "version": "0.1.0",
   "type": "module",
+  "license": "GPL-3.0",
+  "author": {
+    "name": "Musare",
+    "url": "https://github.com/Musare",
+    "email": "[email protected]"
+  },
+  "contributors": [
+    "Kristian Vos <[email protected]>",
+    "Owen Diffey <[email protected]>"
+  ],
+  "homepage": "https://github.com/Musare/vue-draggable-list",
+  "bugs": {
+    "url": "https://github.com/Musare/vue-draggable-list/issues",
+    "email": "[email protected]"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Musare/vue-draggable-list.git"
+  },
   "scripts": {
     "dev": "vite",
     "build": "vite build && vue-tsc --emitDeclarationOnly",

package-lock.json

@@ -6,7 +6,6 @@ const props = defineProps({
     list: { type: Array as PropType<any[]>, default: () => [] },
     attributes: { type: Object, default: () => ({}) },
     tag: { type: String, default: "div" },
-    class: { type: String, default: "" },
     group: { type: String, default: "" },
     disabled: { type: [Boolean, Function], default: false }
 });