From a53dffeb86467e574047208e778443fc94408461 Mon Sep 17 00:00:00 2001 From: Mats Mikkel Rummelhoff Date: Thu, 28 Mar 2024 15:12:32 +0100 Subject: [PATCH] Fix README --- README.md | 28 ++++------------------------ 1 file changed, 4 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 223f19c..6a42e89 100644 --- a/README.md +++ b/README.md @@ -6,25 +6,9 @@ PlainText drop-in replacement that can be set to `disabled`, `hidden` or `readon This plugin requires Craft CMS 5.0 or later. -[Looking for the Craft 2 version?](https://github.com/mmikkel/IncognitoField-Craft) +## What is it? -## Installation - -To install the plugin, follow these instructions. - -1. Open your terminal and go to your Craft project: - - cd /path/to/project - -2. Then tell Composer to load the plugin: - - composer require mmikkel/incognito-field - -3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Incognito Field. - -## Incognito Field Overview - -Incognito Field adds a custom FieldType to Craft CMS, called Incognito. Incognito fields work exactly like regular PlainText fields, except that they can be configured to be `disabled`, `readonly` or `hidden` for element editor forms. +Incognito Field adds a custom fieldType to Craft CMS called Incognito. Incognito fields work exactly like regular PlainText fields, except that they can be configured to be `disabled`, `readonly` or `hidden` for element edit forms. A good example use case for Incognito is whenever you need a field that shouldn't be editable via the CP – e.g. if you want to save some data from a feed or external API on your element model. @@ -32,7 +16,7 @@ _Incognito Field works both standalone and inside Matrix blocks._ ## Configuring Incognito Field -Create a new field (or convert an existing Plain Text field) as _Incognito Field_. Select the rendering mode you want in the _Mode_ setting to make the field `hidden`, `readonly`, `disabled` (or a regular, visible and editable PlainText field). optionally override the mode in _Mode Override_ which you can find in the advanced field settings. +Create a new field (or convert an existing Plain Text field) as _Incognito Field_. Select the rendering mode you want in the _Mode_ setting to make the field `hidden`, `readonly`, `disabled` (or a regular, visible and editable PlainText field). Optionally, override the mode in _Mode Override_ which you can find in the advanced field settings. ### Overriding the rendering mode with Twig logic @@ -67,8 +51,4 @@ Render as an editable PlainText field for users that have _edit site permissions ## Disclaimer -This plugin is provided free of charge and you can do whatever you want with it. Incognito Field is unlikely to mess up your stuff, but just to be clear: the author is not responsible for data loss or any other problems resulting from the use of this plugin. - -Please report any bugs, feature requests or other issues [here](https://github.com/mmikkel/IncognitoField-Craft3/issues). Note that this is a hobby project and no promises are made regarding response time, feature implementations or bug fixes. - -**Pull requests are extremely welcome** +Please report any bugs, feature requests or other issues [here](https://github.com/mmikkel/IncognitoField-Craft3/issues).