Skip to content

Commit

Permalink
Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
mmikkel committed Mar 28, 2024
1 parent 4f59466 commit a53dffe
Showing 1 changed file with 4 additions and 24 deletions.
28 changes: 4 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,17 @@ 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.

_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

Expand Down Expand Up @@ -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).

0 comments on commit a53dffe

Please sign in to comment.