aws-amplify · sammartinez · Aug 23, 2021 · Oct 12, 2020 · Oct 12, 2020 · Oct 13, 2020
@@ -17,7 +17,7 @@
   </a>
 </p>
 
-### Reporting Bugs/Feature Requests
+### Reporting Bugs / Feature Requests
 
 [![Open Bugs](https://img.shields.io/github/issues/aws-amplify/amplify-js/bug?color=d73a4a&label=bugs)](https://github.com/aws-amplify/amplify-js/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
 [![Feature Requests](https://img.shields.io/github/issues/aws-amplify/amplify-js/feature-request?color=ff9001&label=feature%20requests)](https://github.com/aws-amplify/amplify-js/issues?q=is%3Aissue+label%3Afeature-request+is%3Aopen)
@@ -29,67 +29,34 @@ AWS Amplify provides a declarative and easy-to-use interface across different ca
 
 Our default implementation works with Amazon Web Services (AWS), but AWS Amplify is designed to be open and pluggable for any custom backend or service.
 
-## Notice:
-
-### Amplify 4.x.x has breaking changes for React Native. Please see the breaking changes below:
-
-- If you are using React Native or Expo, you will need add `@react-native-async-storage/async-storage` as a dependency to your application, in addition to the other React Native dependencies:
-
-```
-// React Native
-yarn add aws-amplify amazon-cognito-identity-js @react-native-community/netinfo @react-native-async-storage/async-storage
-npx pod-install
-
-// Expo
-yarn add aws-amplify @react-native-community/netinfo @react-native-async-storage/async-storage
-```
-
-### Amplify 3.x.x has breaking changes. Please see the breaking changes below:
-
-- `AWS.credentials` and `AWS.config` don’t exist anymore anywhere in Amplify JavaScript.
-  - Both options will not be available to use in version 3. You will not be able to use and set your own credentials.
-  - For more information on this change, please see the [AWS SDK for JavaScript v3](https://github.com/aws/aws-sdk-js-v3/#configuration)
-- `aws-sdk@2.x` has been removed from `Amplify@3.x.x` in favor of [version 3 of aws-sdk-js](https://github.com/aws/aws-sdk-js-v3). We recommend to migrate to [aws-sdk-js-v3](https://github.com/aws/aws-sdk-js-v3) if you rely on AWS services that are not supported by Amplify, since [aws-sdk-js-v3](https://github.com/aws/aws-sdk-js-v3) is imported modularly.
+#### Visit our [Documentation site](https://docs.amplify.aws/) to learn more about AWS Amplify. Please see our [Amplify JavaScript](https://docs.amplify.aws/lib/q/platform/js/) page within our Documentation site for information around the full list of features we support.
 
-If you can't migrate to [aws-sdk-js-v3](https://github.com/aws/aws-sdk-js-v3) or rely on aws-sdk@2.x, you will need to import it separately.
-
-- If you are using exported paths within your Amplify JS application, (e.g. `import from "@aws-amplify/analytics/lib/Analytics"`) this will now break and no longer will be supported. You will need to change to named imports:
-
-  ```js
-  import { Analytics } from 'aws-amplify';
-  ```
-
-- If you are using categories as `Amplify.<Category>`, this will no longer work and we recommend to import the category you are needing to use:
-
-  ```js
-  import { Auth } from 'aws-amplify';
-  ```
-
-### Features / APIs
-
-- [**Authentication**](https://docs.amplify.aws/lib/auth/getting-started/q/platform/js): APIs and building blocks for developers who want to create user authentication experiences.
-- [**Analytics**](https://docs.amplify.aws/lib/analytics/getting-started/q/platform/js): Easily collect analytics data for your app. Analytics data includes user sessions and other custom events that you want to track in your app.
-- [**REST API**](https://docs.amplify.aws/lib/restapi/getting-started/q/platform/js): Provides a simple solution when making HTTP requests. It provides an automatic, lightweight signing process which complies with AWS Signature Version 4.
-- [**Geo (Developer preview)**](https://docs.amplify.aws/lib/geo/getting-started/q/platform/js): Amplify Geo provides APIs and map UI components for maps and location search for JavaScript-based web apps.
-- [**GraphQL API**](https://docs.amplify.aws/lib/graphqlapi/getting-started/q/platform/js): Interact with your GraphQL server or AWS AppSync API with an easy-to-use & configured GraphQL client.
-- [**DataStore**](https://docs.amplify.aws/lib/datastore/getting-started/q/platform/js): A programming model for leveraging shared and distributed data without writing additional code for offline and online scenarios, which makes working with distributed, cross-user data just as simple as working with local-only data.
-- [**Storage**](https://docs.amplify.aws/lib/storage/getting-started/q/platform/js): Provides a simple mechanism for managing user content for your app in public, protected or private storage buckets.
-- [**Push Notifications**](https://docs.amplify.aws/lib/push-notifications/getting-started/q/platform/js): Allows you to integrate push notifications in your app with Amazon Pinpoint targeting and campaign management support.
-- [**Interactions**](https://docs.amplify.aws/lib/interactions/getting-started/q/platform/js#interactions-with-aws): Create conversational bots powered by deep learning technologies.
-- [**PubSub**](https://docs.amplify.aws/lib/pubsub/getting-started/q/platform/js): Provides connectivity with cloud-based message-oriented middleware.
-- [**Internationalization**](https://docs.amplify.aws/lib/utilities/i18n/q/platform/js): A lightweight internationalization solution.
-- [**Cache**](https://docs.amplify.aws/lib/utilities/cache/q/platform/js): Provides a generic LRU cache for JavaScript developers to store data with priority and expiration settings.
-- [**Predictions**](https://docs.amplify.aws/lib/predictions/getting-started/q/platform/js): Provides a solution for using AI and ML cloud services to enhance your application.
-
-#### Visit our [Web Site](https://docs.amplify.aws/) to learn more about AWS Amplify.
-
-- [Documentation](https://docs.amplify.aws/)
 - [Demo Applications](https://github.com/aws-amplify/amplify-js-samples)
 - [Contributing](https://github.com/aws-amplify/amplify-js/blob/main/CONTRIBUTING.md)
 
+### Features
+
+| Category                                                                                                          | AWS Provider                                                | Description                                                                                                            |
+| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| [**Authentication**](https://docs.amplify.aws/lib/auth/getting-started/q/platform/js)                             | [Amazon Cognito](https://aws.amazon.com/cognito/)           | APIs and Building blocks to create Authentication experiences.                                                         |
+| [**Analytics**](https://docs.amplify.aws/lib/analytics/getting-started/q/platform/js)                             | [Amazon Pinpoint](https://aws.amazon.com/pinpoint/)         | Collect Analytics data for your application including tracking user sessions.                                          |
+| [**REST API**](https://docs.amplify.aws/lib/restapi/getting-started/q/platform/js)                                | [Amazon API Gateway](https://aws.amazon.com/api-gateway/)   | Sigv4 signing and AWS auth for API Gateway and other REST endpoints.                                                   |
+| [**GraphQL API**](https://docs.amplify.aws/lib/graphqlapi/getting-started/q/platform/js)                          | [AWS AppSync](https://aws.amazon.com/appsync/)              | Interact with your GraphQL or AWS AppSync endpoint(s).                                                                 |
+| [**DataStore**](https://docs.amplify.aws/lib/datastore/getting-started/q/platform/js)                             | [AWS AppSync](https://aws.amazon.com/appsync/)              | Programming model for shared and distributed data, with simple online/offline synchronization.                         |
+| [**Storage**](https://docs.amplify.aws/lib/storage/getting-started/q/platform/js)                                 | [Amazon S3](https://aws.amazon.com/s3/)                     | Manages content in public, protected, private storage buckets.                                                         |
+| [**Geo (Developer preview)**](https://docs.amplify.aws/lib/geo/getting-started/q/platform/js)                     | [Amazon Location Service](https://aws.amazon.com/location/) | Provides APIs and UI components for maps and location search for JavaScript-based web apps.                            |
+| [**Push Notifications**](https://docs.amplify.aws/lib/push-notifications/getting-started/q/platform/js)           | [Amazon Pinpoint](https://aws.amazon.com/pinpoint/)         | Allows you to integrate push notifications in your app with Amazon Pinpoint targeting and campaign management support. |
+| [**Interactions**](https://docs.amplify.aws/lib/interactions/getting-started/q/platform/js#interactions-with-aws) | [Amazon Lex](https://aws.amazon.com/lex/)                   | Create conversational bots powered by deep learning technologies.                                                      |
+| [**PubSub**](https://docs.amplify.aws/lib/pubsub/getting-started/q/platform/js)                                   | [AWS IoT](https://aws.amazon.com/iot/)                      | Provides connectivity with cloud-based message-oriented middleware.                                                    |
+| [**Internationalization**](https://docs.amplify.aws/lib/utilities/i18n/q/platform/js)                             | ---                                                         | A lightweight internationalization solution.                                                                           |
+| [**Cache**](https://docs.amplify.aws/lib/utilities/cache/q/platform/js)                                           | ---                                                         | Provides a generic LRU cache for JavaScript developers to store data with priority and expiration settings.            |
+| [**Predictions**](https://docs.amplify.aws/lib/predictions/getting-started/q/platform/js)                         | Various\*                                                   | Connect your app with machine learning services like NLP, computer vision, TTS, and more.                              |
+
+- Predictions utilizes a range of Amazon's Machine Learning services, including: Amazon Comprehend, Amazon Polly, Amazon Rekognition, Amazon Textract, and Amazon Translate.
+
 ## Getting Started
 
-AWS Amplify is available as `aws-amplify` package on [npm](https://www.npmjs.com/).
+AWS Amplify is available as `aws-amplify` package on [npm](https://www.npmjs.com/package/aws-amplify).
 
 **Web**
 
@@ -122,3 +89,39 @@ $ npm install aws-amplify-react-native --save
 ```
 
 Visit our [Installation Guide for React Native](https://docs.amplify.aws/start/q/integration/react-native) to start building your web app.
+
+## Notice:
+
+### Amplify 4.x.x has breaking changes for React Native. Please see the breaking changes below:
+
+- If you are using React Native or Expo, you will need to add `@react-native-async-storage/async-storage` as a dependency to your application, in addition to the other React Native dependencies:
+
+```
+// React Native
+yarn add aws-amplify amazon-cognito-identity-js @react-native-community/netinfo @react-native-async-storage/async-storage
+npx pod-install
+
+// Expo
+yarn add aws-amplify @react-native-community/netinfo @react-native-async-storage/async-storage
+```
+
+### Amplify 3.x.x has breaking changes. Please see the breaking changes below:
+
+- `AWS.credentials` and `AWS.config` don’t exist anymore in Amplify JavaScript.
+  - Both options will not be available to use in version 3. You will not be able to use and set your own credentials.
+  - For more information on this change, please see the [AWS SDK for JavaScript v3](https://github.com/aws/aws-sdk-js-v3/#configuration)
+- `aws-sdk@2.x` has been removed from `Amplify@3.x.x` in favor of [version 3 of aws-sdk-js](https://github.com/aws/aws-sdk-js-v3). We recommend to migrate to [aws-sdk-js-v3](https://github.com/aws/aws-sdk-js-v3) if you rely on AWS services that are not supported by Amplify, since [aws-sdk-js-v3](https://github.com/aws/aws-sdk-js-v3) is imported modularly.
+
+If you can't migrate to [aws-sdk-js-v3](https://github.com/aws/aws-sdk-js-v3) or rely on aws-sdk@2.x, you will need to import it separately.
+
+- If you are using exported paths within your Amplify JS application, (e.g. `import from "@aws-amplify/analytics/lib/Analytics"`) this will now break and no longer will be supported. You will need to change to named imports:
+
+  ```js
+  import { Analytics } from 'aws-amplify';
+  ```
+
+- If you are using categories as `Amplify.<Category>`, this will no longer work and we recommend to import the category you are needing to use:
+
+  ```js
+  import { Auth } from 'aws-amplify';
+  ```