mirror of
https://github.com/Codappix/search_core.git
synced 2024-12-04 16:36:11 +01:00
FEATURE: Add readme by reusing documentation
This commit is contained in:
parent
a87bbc8e27
commit
e6b244d7f6
3 changed files with 33 additions and 30 deletions
|
@ -1,33 +1,4 @@
|
|||
TYPO3 Extension search_core's documentation!
|
||||
============================================
|
||||
|
||||
Introduction
|
||||
============
|
||||
|
||||
What does it do?
|
||||
----------------
|
||||
|
||||
The goal of this extension is to provide search integrations into TYPO3 CMS. The extension will
|
||||
abstract the concrete implementations to allow exchange of concrete backends like elasticsearch or
|
||||
solr.
|
||||
|
||||
The extension provides integration into TYPO3 like a frontend plugin for searches and hooks to
|
||||
update search indexes on updates. Also a command line interface is provided for interactions like
|
||||
reindexing.
|
||||
|
||||
Current state
|
||||
-------------
|
||||
|
||||
This is still a very early alpha version. More information can be taken from Github at
|
||||
`current issues`_ and `current projects`_.
|
||||
|
||||
We are also focusing on Code Quality and Testing through `travis ci`_, `scrutinizer`_ and `codacy`_.
|
||||
|
||||
.. _current issues: https://github.com/DanielSiepmann/search_core/issues
|
||||
.. _current projects: https://github.com/DanielSiepmann/search_core/projects
|
||||
.. _travis ci: https://travis-ci.org/DanielSiepmann/search_core
|
||||
.. _scrutinizer: https://scrutinizer-ci.com/g/DanielSiepmann/search_core/inspections
|
||||
.. _codacy: https://www.codacy.com/app/daniel-siepmann/search_core/dashboard
|
||||
.. include:: readme.rst
|
||||
|
||||
Table of Contents
|
||||
=================
|
||||
|
|
31
Documentation/source/readme.rst
Normal file
31
Documentation/source/readme.rst
Normal file
|
@ -0,0 +1,31 @@
|
|||
TYPO3 Extension search_core's documentation!
|
||||
============================================
|
||||
|
||||
Introduction
|
||||
============
|
||||
|
||||
What does it do?
|
||||
----------------
|
||||
|
||||
The goal of this extension is to provide search integrations into TYPO3 CMS. The extension will
|
||||
abstract the concrete implementations to allow exchange of concrete backends like elasticsearch or
|
||||
solr.
|
||||
|
||||
The extension provides integration into TYPO3 like a frontend plugin for searches and hooks to
|
||||
update search indexes on updates. Also a command line interface is provided for interactions like
|
||||
reindexing.
|
||||
|
||||
Current state
|
||||
-------------
|
||||
|
||||
This is still a very early alpha version. More information can be taken from Github at
|
||||
`current issues`_ and `current projects`_.
|
||||
|
||||
We are also focusing on Code Quality and Testing through `travis ci`_, `scrutinizer`_ and `codacy`_.
|
||||
|
||||
.. _current issues: https://github.com/DanielSiepmann/search_core/issues
|
||||
.. _current projects: https://github.com/DanielSiepmann/search_core/projects
|
||||
.. _travis ci: https://travis-ci.org/DanielSiepmann/search_core
|
||||
.. _scrutinizer: https://scrutinizer-ci.com/g/DanielSiepmann/search_core/inspections
|
||||
.. _codacy: https://www.codacy.com/app/daniel-siepmann/search_core/dashboard
|
||||
|
1
readme.rst
Symbolic link
1
readme.rst
Symbolic link
|
@ -0,0 +1 @@
|
|||
Documentation/source/readme.rst
|
Loading…
Reference in a new issue