Skip to content

Commit

Permalink
Use Drupal recommended format for README
Browse files Browse the repository at this point in the history
  • Loading branch information
froboy committed Dec 3, 2018
1 parent 98a0b86 commit fffef34
Showing 1 changed file with 48 additions and 6 deletions.
54 changes: 48 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,54 @@
# Fields Search API Module
INTRODUCTION
------------

This module facilitates indexing data from multiple Drupal sites into a single Solr search index.
The Search API Field Map module facilitates indexing data from multiple Drupal sites into a single Apache Solr search index.

* For a full description of the module, visit the project page:

* Please use GitHub submit bug reports and feature suggestions, or to track changes:
https://github.com/palantirnet/search_api_field_map


REQUIREMENTS
------------

This module requires the following modules:

* Search API (https://www.drupal.org/project/search_api)
* Token (https://www.drupal.org/project/token)

Additionally, it is recommended to configure Search API to send data to an Apache Solr server.


INSTALLATION
------------

* Install as you would normally install a contributed Drupal module. Visit:
https://www.drupal.org/documentation/install/modules-themes/modules-8
for further information.


CONFIGURATION
------------

On each site included in the mapped field search, you will need to:

1. Install this module
2. Configure a Search API server to connect to the shared Solr index
1. Configure a Search API server to connect to the shared Solr index
2. [Follow these detailed instructions](docs/usage.md) to configure your fields.


TROUBLESHOOTING & FAQ
---------------------

TBD


MAINTAINERS
-----------

## More information
Current maintainers:
* Avi Schwab (froboy) - https://www.drupal.org/u/froboy
* Ken Rickard (agentrickard) - https://www.drupal.org/u/agentrickard

* [How to use this module](docs/usage.md)
This project has been sponsored by:
* Palantir.net (https://palantir.net)

0 comments on commit fffef34

Please sign in to comment.