From 50946b73af320ae185284f06cd490e08256b19c2 Mon Sep 17 00:00:00 2001
From: Krombel <krombel@krombel.de>
Date: Sat, 3 Mar 2018 11:45:57 +0100
Subject: [PATCH] add HowToInstall to README; add folder internal

---
 README.md                          | 15 +++++++++++++++
 {public => internal}/login.php     |  0
 public/{register.php => index.php} |  0
 3 files changed, 15 insertions(+)
 rename {public => internal}/login.php (100%)
 rename public/{register.php => index.php} (100%)

diff --git a/README.md b/README.md
index 65b3e54..b613d0f 100644
--- a/README.md
+++ b/README.md
@@ -13,3 +13,18 @@ This is done in several steps:
   - provides that credentials to [matrix-synapse-rest-auth](https://github.com/kamax-io/matrix-synapse-rest-auth#integrate) which has to be configured to query login.php
 
 2nd step: Implement the other apis to integrade [mxisd](https://github.com/kamax-io/mxisd/blob/master/docs/backends/rest.md)
+
+## How to install
+
+- Copy `config.sample.php` to `config.php` and configure the bot as you can find there
+- Configure your webserver to publish the folder `public` and configure.
+  The folder `internal` contains files that can be accessed by mxisd or matrix-synapse-rest-auth
+- To integrate with matrix-synapse-rest-auth:
+  - `/_matrix-internal/identity/v1/check_credentials` should map to `internal/login.php`
+- To integrate with mxisd: Have a look at [the docs](https://github.com/kamax-io/mxisd/blob/master/docs/backends/rest.md) and apply as follows:
+| Key                            | file which handles that | Description                                          |
+|--------------------------------|-------------------------|------------------------------------------------------|
+| rest.endpoints.auth            | internal/login.php      | Validate credentials and get user profile            |
+| rest.endpoints.directory       | to follow               | Search for users by arbitrary input                  |
+| rest.endpoints.identity.single | to follow               | Endpoint to query a single 3PID                      |
+| rest.endpoints.identity.bulk   | to follow               | Endpoint to query a list of 3PID                     |
diff --git a/public/login.php b/internal/login.php
similarity index 100%
rename from public/login.php
rename to internal/login.php
diff --git a/public/register.php b/public/index.php
similarity index 100%
rename from public/register.php
rename to public/index.php