Merge pull request #22 from namecheap/feature/fetchAppsByDiscoveryMet…

…adata

doc/registry_api.md

@@ -0,0 +1,21 @@
+# Registry Api
+
+Sometimes can be necessary to work with ILC Registry API.
+Of course, you can do it via HTTP directly, but we recommend doing it via class RegistryApi which provides convenient capabilities to work with ILC Registry, e.g. retrieve some data, etc.
+
+### discoverApps
+`discoverApps` can by useful for instance when you use [Parcels](https://github.com/namecheap/ilc/blob/1a864a41c7717d2d33156ec5d261d064f92afc63/docs/parcels.md).
+Instead of hardcode app names - you can group apps with some keywords (discoveryMetadata), retrieve in runtime via `discoverApps` and render them.
+
+```javascript
+import { RegistryApi } from 'ilc-sdk';
+
+const registryOrigin = 'http://localhost:4001';
+const registryApi = new RegistryApi(registryOrigin);
+
+// retrieve apps by discoveryMetadata field which should be rendered at some specific place
+registryApi.discoverApps({ greatestApp: true })
+.then(apps => {
+    console.log(apps);
+});
+```