Add base functionality

CHANGELOG.md

@@ -1,4 +1,4 @@
-# Release Notes for craft-quick-edit
+# Release Notes for Quick Edit
 
-## 1.0.0
-- Initial release
+## 5.0.0 - 2025-01.19
+- Initial Release

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) Pixel & Tonic, Inc.
+Copyright (c) Samuel Reichör
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,30 +1,45 @@
-# craft-quick-edit
-
-A plugin that adds a cp edit url to the frontend.
+<div align="center">
+	<a href="https://packagist.org/packages/samuelreichor/craft-quick-edit" align="center">
+      <img src="https://online-images-sr.netlify.app/assets/craft-quick-edit.png" width="100" alt="Quick Edit">
+	</a>
+  <br>
+	<h1 align="center">Quick Edit for Craft CMS</h1>
+  <p align="center">
+    Quick Edit is a Craft CMS plugin that provides an edit entry link for your frontend.
+  </p>
+  <br/>
+</div>
+
+<p align="center">
+  <a href="https://packagist.org/packages/samuelreichor/craft-quick-edit">
+    <img src="https://img.shields.io/packagist/v/samuelreichor/craft-quick-edit?label=version&color=blue">
+  </a>
+  <a href="https://packagist.org/packages/samuelreichor/craft-quick-edit">
+    <img src="https://img.shields.io/packagist/dt/samuelreichor/craft-quick-edit?color=blue">
+  </a>
+  <a href="https://packagist.org/packages/samuelreichor/craft-quick-edit">
+    <img src="https://img.shields.io/packagist/php-v/samuelreichor/craft-quick-edit?color=blue">
+  </a>
+  <a href="https://packagist.org/packages/samuelreichor/craft-quick-edit">
+    <img src="https://img.shields.io/packagist/l/samuelreichor/craft-quick-edit?color=blue">
+  </a>
+</p>
+
+## Features
+
+- Compatible with pages cached by Blitz.
+- Fully customizable styling.
+- Displays only if the logged-in user has permission to save the entry.
+- No configuration required.
 
 ## Requirements
 
 This plugin requires Craft CMS 5.0.0 or later, and PHP 8.2 or later.
 
-## Installation
-
-You can install this plugin from the Plugin Store or with Composer.
-
-#### From the Plugin Store
-
-Go to the Plugin Store in your project’s Control Panel and search for “craft-quick-edit”. Then press “Install”.
-
-#### With Composer
-
-Open your terminal and run the following commands:
+## Documentation
 
-```bash
-# go to the project directory
-cd /path/to/my-project.test
+Visit the [Quick Edit page](https://samuelreichor.at/libraries/craft-quick-edit) for all documentation and guides.
 
-# tell Composer to load the plugin
-composer require samuelreichor/craft-quick-edit
+## Support
 
-# tell Craft to install the plugin
-./craft plugin/install craft-quick-edit
-```
+If you encounter bugs or have feature requests, [please submit an issue](/../../issues/new). Your feedback helps improve the library!

composer.json

@@ -3,13 +3,21 @@
   "description": "A plugin that adds a cp edit url to the frontend.",
   "type": "craft-plugin",
   "license": "mit",
+  "version": "5.0.0",
   "support": {
     "email": "[email protected]",
-    "issues": "https://github.com/samuelreichor/craft-qick-edit/issues?state=open",
-    "source": "https://github.com/samuelreichor/craft-qick-edit",
-    "docs": "https://github.com/samuelreichor/craft-qick-edit",
-    "rss": "https://github.com/samuelreichor/craft-qick-edit/releases.atom"
+    "issues": "https://github.com/samuelreichor/craft-quick-edit/issues?state=open",
+    "source": "https://github.com/samuelreichor/craft-quick-edit",
+    "docs": "https://github.com/samuelreichor/craft-quick-edit",
+    "rss": "https://github.com/samuelreichor/craft-quick-edit/releases.atom"
   },
+  "keywords": [
+    "craftcms",
+    "craft-plugin",
+    "enhence author experience",
+    "edit page link",
+    "quick edit"
+  ],
   "require": {
     "php": ">=8.2",
     "craftcms/cms": "^5.0.0"
@@ -24,11 +32,11 @@
     }
   },
   "extra": {
-    "handle": "craft-quick-edit",
-    "name": "craft-quick-edit",
+    "handle": "quick-edit",
+    "name": "Quick Edit",
     "developer": "Samuel Reichör",
-    "documentationUrl": "https://github.com/samuelreichor/craft-qick-edit",
-    "class": "samuelreichor\\quickedit\\QickEdit"
+    "documentationUrl": "https://samuelreichor.at/libraries/craft-quick-edit",
+    "class": "samuelreichor\\quickedit\\QuickEdit"
   },
   "scripts": {
     "check-cs": "ecs check --ansi",
@@ -44,5 +52,11 @@
       "yiisoft/yii2-composer": true,
       "craftcms/plugin-installer": true
     }
-  }
-}
+  },
+  "authors": [
+    {
+      "name": "Samuel Reichör",
+      "homepage": "https://samuelreichor.at/libraries"
+    }
+  ]
+}