From b07773d951776b31b085b56c0d874c7962b73cdc Mon Sep 17 00:00:00 2001
From: C Beach <cbeach@unicon.net>
Date: Sat, 16 Jan 2021 08:41:54 -0600
Subject: [PATCH] Initial thoughts on design

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index b3e794e..c9f22a1 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,27 @@
 # openEQUELLA-slideshow
 Web component that leverages openEQUELLA content in a configurable slideshow
+
+The slideshow displays images from oEQ items.  To find the items to display, it leverages the search REST API of oEQ.
+
+The slideshow allows 'in app' configuration of the search query to dynamically change the slideshow. Alternatively, the slideshow can be configured with a `search-query` property the handles the configuration.
+
+For items with multiple images, the slideshow will iterate through all of them, displaying them one at a time.
+
+To install the web component on a web page:
+```javascript
+<script src="https://some-hosted-site/oeq-slideshow.js"></script>
+<div style="width:600;">
+  <oeq-slideshow
+    oeq-url="https://some-hosted-oeq-site/"
+    search-query="/api/search?q=keyword%20query&start=0&length=10&order=name&reverse=false&info=attachment&showall=false&status=LIVE">
+  </oeq-slideshow>
+</div>
+```
+
+## Future goals
+- Support audio files
+- Support video files
+- Display a caption (from a configurable metadata field)
+- Display a link to directly go to the item whose content is being displayed
+- Have the ability to pause the slideshow and update the metadata (which will be saved in oEQ) for the current piece of content
+-