docs: update readme

loopbackio · Jan 3, 2018 · fbf4b76 · fbf4b76
1 parent 278850c
commit fbf4b76
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/packages/openapi-v2/README.md b/packages/openapi-v2/README.md
@@ -2,8 +2,15 @@
 
 This package contains:
 
-- Decorators that describe LoopBack artifacts as metadata.
-- Uilities that tranfer LoopBack remoting metadata to swagger specifications. 
+- Decorators that describe LoopBack artifacts as OpenAPI v2 (Swagger) metadata.
+- Utilities that tranfer LoopBack metadata to OpenAPI v2 (Swagger) swagger specifications. 
+
+## Overview
+
+The package has functions described above for LoopBack controller classes.
+Decorators apply REST api mapping metadata to controller classes and their members. And utilities that inspect controller classes to build OpenAPI v2 (Swagger) specifications from REST api mapping metadata.
+
+Functions for more artifacts will be added when we need.
 
 ## Installation