This is an automated email from the ASF dual-hosted git repository.

davidb pushed a commit to branch master
in repository 
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-feature-apiregions.git

commit df4bda4a35d7d0497b76b8c56aa743ac04bb499d
Author: David Bosschaert <[email protected]>
AuthorDate: Mon Nov 5 14:13:24 2018 +0000

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b075f8a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+[<img 
src="http://sling.apache.org/res/logos/sling.png"/>](http://sling.apache.org)
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+# Apache Sling API Regions runtime component
+
+The API Regions runtime component is implemented as an OSGi Framework 
Extension bundle.
+This ensures that the runtime component is always present early in the startup 
process.
+
+This component registers an OSGi resolver hook service which enforces the API 
regions at runtime. The component looks for properties files that provide the 
configuration of the API regions. The properties files are generated by the 
`org.apache.sling.feature.extension.apiregions` component during the extension 
post-processing.
+
+As the component has no dependencies on any other component, the properties 
files are looked up via System Properties lookups:
+
+* `apiregions.idbsnver.properties` - provides the location of the 
`idbsnver.properties` file.
+* `apiregions.bundles.properties` - provides the location of the 
`bundles.properties` file.
+* `apiregions.features.properties` - provides the location of the 
`features.properties` file.
+* `apiregions.regions.properties` - provides the location of the 
`regions.properties` file.

Reply via email to