diff --git a/README.md b/README.md index 3cc9dd5..7e838cf 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ The core concepts used in this project are: 3. **Service information**: Information about the underlying service such as host, port, and credentials. 4. **Application information**: Information about application and instance in which these libraries are embedded. -The project comprises of three subprojects: +The project comprises of four subprojects: 1. **[core](core)**: Core library that is cloud agnostic and Spring agnostic. Provides entry point for application developers that choose to programmatically access cloud services and application information. It also provides an extension mechanism to contribute cloud connectors and service connector creators. 2. **[spring-service-connector](spring-service-connector)**: Library that provides service connectors creators for javax.sql.DataSource and various connection factories spring-data projects. @@ -50,7 +50,7 @@ Add the [`spring-service-connector`](spring-service-connector) and one or more c 0.9.2 -Then follow instructions on [how you use the `` namespace](spring-service-connector). You can also follow the [instructions](core) on using the core API directly. +Then follow instructions on [how you use the Java config and `` namespace](spring-service-connector). You can also follow the [instructions](core) on using the core API directly. Non-spring apps --------------- diff --git a/core/README.md b/core/README.md index e9959cc..854b49b 100644 --- a/core/README.md +++ b/core/README.md @@ -13,6 +13,10 @@ This library also supports an extension to create services connectors of user-de Usage pattern: Application Developers ===================================== +> **Note:** If you are using spring-cloud in a Spring application, you should consider using the +[Java config](../spring-service-connector#the-java-config) or the +[XML namespace support](../spring-service-connector#the-cloud-namespace) instead. + * Create a [`CloudFactory`](src/main/java/org/springframework/cloud/CloudFactory.java) instance. Creation of a `CloudFactory` instance is a bit expensive, so caching such an instance is recommended. If you are using a dependency inject frameworks such as Spring, creating a bean for `CloudFactory`