[39/50] [abbrv] git commit: [flex-utilities] [refs/heads/master] - update read me so it clearer which swcs are required

[jm...@apache.org]

update read me so it clearer which swcs are required


Project: http://git-wip-us.apache.org/repos/asf/flex-utilities/repo
Commit: http://git-wip-us.apache.org/repos/asf/flex-utilities/commit/ca8ef5ce
Tree: http://git-wip-us.apache.org/repos/asf/flex-utilities/tree/ca8ef5ce
Diff: http://git-wip-us.apache.org/repos/asf/flex-utilities/diff/ca8ef5ce

Branch: refs/heads/master
Commit: ca8ef5ced87f872a40e6a3190e10ba0a38b63371
Parents: 3ed1b4f
Author: Justin Mclean <jm...@apache.org>
Authored: Wed Oct 22 12:59:50 2014 +1100
Committer: Justin Mclean <jm...@apache.org>
Committed: Wed Oct 22 12:59:50 2014 +1100

----------------------------------------------------------------------
 Squiggly/README | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flex-utilities/blob/ca8ef5ce/Squiggly/README
----------------------------------------------------------------------
diff --git a/Squiggly/README b/Squiggly/README
index b2fa7b4..e9dc9f5 100644
--- a/Squiggly/README
+++ b/Squiggly/README
@@ -63,8 +63,10 @@ How to use the Squiggly SDK
 Please read the ASDocs (found in docs directory) first to understand the
 classes in Squiggly.
 
-If you are using the SpellChecker class directly, you need.
-- SpellingEngine.swc in [YourProject]/libs folder, you can find it from ./libs
+For Apache FLex projects if you are using the SpellChecker class directly, you need:
+- ApacheFlexSpellingEngine.swc in [YourProject]/libs folder
+- ApacheFlexSpellingFramwork.swc in [YourProject]/libs folder
+- ApacheFlexLinguisticUtils.swc in [YourProject]/libs folder
 - Dictionary files in [YourProject]/src folder
 
 You can obtain en_US, en_CA and en_GB dictionaries under a BSD/MIT-like license
@@ -85,16 +87,18 @@ But note that many of these dictionaries are under LPGL licenses.
 If you are using the simple UI integration feature (SpellUI class), in addition
 to what mentioned above, you also need:
 - SpellingConfig.xml in [YourProject]/src
-- SpellingUI.swc in [YourProject]/src
-- SpellingUIEx.swc (if you need spark support in Flex 4) in [YourProject]/libs 
+- ApacheFlexSpellingUI.swc (if you need mx spoort) in [YourProject]/libs
+- ApacheFlexSpellingUIEx.swc (if you need spark support) in [YourProject]/libs 
+
+Note that you can only support spelling in mx or spark components not both at once.
 
 You can download dictionaries and use those by editing SpellingConfig.xml.
 
 The default name of the config file has changed from AdobeSpellingConfig.xml to
 SpellingConfig.xml.
 
-Here's the content of SpellingConfig.xml, each entry maps the languageCode with
-the relative path for resource files. 
+Here's the typical content of SpellingConfig.xml, each entry maps the languageCode
+with the relative path for resource files. 
 
 <SpellingConfig>
   <LanguageResource language="English" languageCode="en_US"