Initial commit

Author: LukeTowers

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Winter CMS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Plugin.php

@@ -0,0 +1,33 @@
+<?php namespace Winter\Notes;
+
+use System\Classes\PluginBase;
+
+class Plugin extends PluginBase
+{
+    /**
+     * Returns information about this plugin.
+     *
+     * @return array
+     */
+    public function pluginDetails()
+    {
+        return [
+            'name'        => 'winter.notes::lang.plugin.name',
+            'description' => 'winter.notes::lang.plugin.description',
+            'author'      => 'Winter CMS',
+            'icon'        => 'icon-file-text-o'
+        ];
+    }
+
+    /**
+     * Register the plugin's form widgets
+     *
+     * @return array
+     */
+    public function registerFormWidgets()
+    {
+        return [
+            'Winter\Notes\FormWidgets\Notes' => 'notes',
+        ];
+    }
+}

README.md

@@ -0,0 +1,44 @@
+# About
+
+Easily add notes to any record in WinterCMS through a Mac OS-like user experience.
+
+# Installation
+
+To install from the [Marketplace](https://wintercms.com/plugin/winter-notes), click on the "Add to Project" button and then select the project you wish to add it to before updating the project to pull in the plugin.
+
+To install from the backend, go to **Settings -> Updates & Plugins -> Install Plugins** and then search for `Winter.Notes`.
+
+To install from [the repository](https://github.com/wintercms/wn-notes-plugin), clone it into `plugins/winter/notes` and then run `composer update` from your project root in order to pull in the dependencies.
+
+To install it with Composer, run `composer require wintercms/wn-notes-plugin` from your project root.
+
+# Documentation
+
+Simply add the `notes` MorphMany relationship to your model and add a field with a type of `notes` to your fields.yaml to get started.
+
+Example `fields.yaml`:
+
+```yaml
+fields:
+    name:
+        label: Name
+        span: full
+
+tabs:
+    fields:
+        notes: # The name of the relationship the FormWidget will use
+            label: ''
+            tab: Notes
+            type: notes
+            span: full
+            # autosaveDelay: 2000 # The amount of milliseconds to delay after typing stops to trigger an autosave
+            # dateFormat: 'Y-m-d H:i:s' # the php date format for updated_at column
+```
+
+Example MorphMany Relationship definition:
+
+```php
+public $morphMany = [
+    'notes' => [\Winter\Notes\Models\Note::class, 'name' => 'target']
+];
+```

composer.json

@@ -0,0 +1,21 @@
+{
+    "name": "winter/wn-notes-plugin",
+    "type": "winter-plugin",
+    "description": "Easily add notes to any record in WinterCMS",
+    "homepage": "https://github.com/wintercms/wn-notes-plugin",
+    "keywords": ["winter", "wintercms", "notes", "dynamic notes", "macos notes"],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Luke Towers",
+            "email": "luke@luketowers.ca"
+        },
+        {
+            "name": "Eric Yang",
+            "email": "ericy@captive.ca"
+        }
+    ],
+    "require": {
+        "composer/installers": "~1.11"
+    }
+}