Update README.md

Author: modius

README.md

@@ -1,6 +1,12 @@
-# Design
+# AWS Cloudsearch Plugin
 
-This plugin will work in the same basic way as the [Solr Pro Plugin]:
+Cloudsearch Plugin interfaces with the [Amazon Cloudsearch](https://aws.amazon.com/cloudsearch/) service to provide search capabilities for any FarCry application. Cloudsearch is an API based implementation of the SOLR serach engine, and the plugin works similarly to the FarCry [Solr Pro Plugin].
+
+NOTE: This plugin is compatible with FarCry 7.x and over.
+
+> Cloudsearch plugin is available under LGPL and compatible with the open source and commercial licenses of FarCry Core
+
+Base features include:
 
 - config for general settings
 - a content type with records for each indexed type, and settings to
@@ -9,15 +15,16 @@ This plugin will work in the same basic way as the [Solr Pro Plugin]:
 - a library in the application scope that encapsulates searches
   and index updates
 
-For references, these features will not be implemented at this time:
+### Setup
 
-- a default search form / interface (that will need to be implemented 
-  in the project)
-- document boosting / search
-- search term highlighting
-- autocomplete / suggestions
-- facets
-- document content
+- Set up an account with AWS Cloudsearch
+- Add this plugin to the project's plugin directory ./plugins/cloudsearch
+- Register the plugin in the projects constructor; ./www/farcryConstructor.cfm
+- Restart your application
+- Open the "Cloudsearch" config and fill in the details of your service account
+
+
+### AWS Cloudsearch
 
 Notes about [CloudSearch] architecture:
 
@@ -29,11 +36,10 @@ Notes about [CloudSearch] architecture:
   next index, and indexing will fail until the offending documents are 
   updated
 
-Approach:
+### Cloudsearch Features Implmented
 
 1. CloudSearch initialization, discovery, and basic troubleshooting tools,
-   i.e. are we connected, how many documents are there ~1d
-   DONE
+   i.e. are we connected, how many documents are there 
 2. Basic configuration for type indexes, suitable for dmHTML for example
 3. Manual index updates; webtop overview tab that shows what would be sent
    to CloudSearch / is in CloudSearch
@@ -44,5 +50,18 @@ Approach:
    - new indexes
    - changed index configs, i.e. adding properties to index
 
+### Cloudsearch Features Not Yet Implemented
+
+For references, these features will not be implemented at this time:
+
+- a default search form / interface (that will need to be implemented 
+  in the project)
+- document boosting / search
+- search term highlighting
+- autocomplete / suggestions
+- facets
+- document content
+
+
 [Solr Pro Plugin]: https://github.com/jeffcoughlin/farcrysolrpro
-[CloudSearch]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/what-is-cloudsearch.html
+[CloudSearch]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/what-is-cloudsearch.html