Merge pull request #4 from theweekendgeek/master

added sdk and plugin info

conf.py

@@ -70,7 +70,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = 'de'
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

getting_started/how_to_develop_plugins.md

@@ -0,0 +1,16 @@
+# Third-Party integrations
+
+It is very easy to integrate aiphilos into a third-party system. To begin you only have to:
+
+### create an aiPhilos account
+To be able to develop and test your plugin you will need to create an account on our webseite aiphilos.com. A freemium account should be sufficient to develop and test a working integration.
+
+### get in touch about becoming a affiliate developer
+Visit our [webseite](https://www.aiphilos.com/partnerprogramm/entwicklungspartner) and get in touch with us via one of the described methods. You will receive the neccessary information to start developing your third-party integration as an affiliate developer.
+
+
+### download the neccessary SDK
+we provide SDKs to make aiPhilos integration easier. Download the one you need and integrate it into your project.
+
+### start developing!
+

getting_started/index.rst

@@ -1,5 +1,12 @@
+aiPhilos Integration
+====================
+
+aiPhilos is usually utilized via the use of small applications, usually called plugins or addons.
+These small applications are then integrated into third party solutions like Shopware and enable them to leverage the capability of aiPhilos semantic search.
+
 .. toctree::
    :maxdepth: 1
    :name: toc-getting_started
 
+   how_to_develop_plugins
    shopware

index.rst

@@ -1,13 +1,13 @@
 .. aiphilos documentation master file.
 
-aiPhilos Dokumentation
+aiPhilos Documentation
 ======================
 
-Willkommen in der offiziellen aiPhilos-Dokumentation.
+Welcome to the official aiPhilos documentation.
 
 .. toctree::
    :maxdepth: 2
-   :caption: Über aiPhilos
+   :caption: About aiPhilos
    :name: sec-about
 
    about/index
@@ -26,7 +26,7 @@ Willkommen in der offiziellen aiPhilos-Dokumentation.
 
    sdks/index
 
-Index und Verzeichnisse
+Index And Directories
 =======================
 
 * :ref:`genindex`

sdks/index.rst

@@ -1,5 +1,15 @@
+SDKs
+====
+
+Here you'll find  a list of our SDKs that are currently available on github_.
+
 .. toctree::
    :maxdepth: 1
    :name: toc-sdks
 
    php
+
+Need a SDK for another language? Contact us or create it!
+
+.. _github: https://github.com/aiphilos
+

sdks/php.md

@@ -1 +1,53 @@
-# aiPhilos PHP
+# aiPhilos PHP-SDK
+
+[![Build Status](https://travis-ci.org/aiphilos/api-sdk-php.svg?branch=master)](https://travis-ci.org/aiphilos/api-sdk-php) [![Latest Stable Version](https://poser.pugx.org/aiphilos/api-sdk-php/v/stable)](https://packagist.org/packages/aiphilos/api-sdk-php) [![Total Downloads](https://poser.pugx.org/aiphilos/api-sdk-php/downloads)](https://packagist.org/packages/aiphilos/api-sdk-php) [![Latest Unstable Version](https://poser.pugx.org/aiphilos/api-sdk-php/v/unstable)](https://packagist.org/packages/aiphilos/api-sdk-php) [![License](https://poser.pugx.org/aiphilos/api-sdk-php/license)](https://packagist.org/packages/aiphilos/api-sdk-php)
+
+Currently, **aiPhilos** provides two sets of APIs:
+- **items** provides a real-time database and search engine using the **semantics** API (see below) improving search results and indexing through understanding natural language, adding natural language analysis and Artificial Intelligence as a component to understand your data set
+- **semantics** can split natural human language input into machine-readable chunks and attach additional information usable to deepen natural language understanding in your application (tokenization, part of speech tagging, word classes and categories, named entity recognition, lexicographical data, synonyms/hypernyms/hyponyms, similarity and sentiment data, and learned knowledge)
+
+## Installation
+The easiest way to install this library is to use [composer](https://getcomposer.org/).
+
+```json
+{
+    "require": {
+        "aiphilos/api-sdk-php": "1.*"
+    }
+}
+```
+
+## Usage
+### Semantics (Semantic analysis of natural language input)
+
+#### Creating and configuring the client
+```php
+// Create client
+$client = new Aiphilos\Api\Semantics\Client();
+
+// Configure client
+$client->setAuthCredentials('user', 'pass');
+$client->setDefaultLanguage('de-de');
+```
+
+#### Parsing a single string
+```php
+$res = $client->parseString('Ordner');
+```
+
+#### Parsing multiple strings
+```php
+$res = $client->parseStrings(array('Ordner leitz', 'tastatur'));
+
+// Alternative
+$res = $client->parseStrings(array('example_1' => 'Ordner leitz', 'example_2' => 'tastatur'));
+```
+
+#### Using custom implementations for Lexemes and Synsets
+```php
+Aiphilos\Api\Semantics\LexemeFactory::setDefaultClass('My\Namespace\And\Classname'); // Instance of Aiphilos\Api\Semantics\LexemeInterface
+Aiphilos\Api\Semantics\SynsetFactory::setDefaultClass('My\Namespace\And\Classname'); // Instance of Aiphilos\Api\Semantics\SynsetInterface
+```
+
+### Items (Database and search engine)
+**TBD**