[TASK] Add README.md

This commit is contained in:
Christian Kuhn 2019-01-20 11:28:47 +01:00
parent ff8f9195c7
commit 506d650495

32
README.md Normal file
View file

@ -0,0 +1,32 @@
# TYPO3 Extension "feedit"
This TYPO3 extension is a simple solution to edit TYPO3 page content elements
directly in the frontend as a logged in backend user. It adds edit icons around
elements for this.
The functionality was part of the TYPO3 Core until TYPO3 v10.0, and moved into its
own extension, receiving its own public repository.
## Installation
The latest version can be installed via TER (http://typo3.org) or via composer
by adding ''composer require friendsoftypo3/feedit'' in a TYPO3 v10.0+ installation.
## Current state
The extension has been part of TYPO3 Core for a very long time but never
received much love. It may become more healthy if maintained as third party
extension and has been extracted for this reason.
## Contribution
Feel free to submit any pull request, or add documentation, tests, as you please.
We will publish a new version every once in a while, depending on the amount of changes
and pull requests submitted.
### License
The extension is published under GPL v2+, all included third-party libraries are
published under their respective licenses.
### Authors
Many contributors have been working on this area while this functionality was part of
the TYPO3 Core. This package is now maintained by a loose group of TYPO3 enthusiasts inside
the TYPO3 Community. Feel free to contact Benni Mack (benni.mack@typo3.org) for any questions
regarding "feedit".