Update nfvo-lcm version

[vfc/nfvo/lcm.git] / README.md

diff --git a/README.md b/README.md
index 7b59118..8ef60ac 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,3 +13,27 @@
 # limitations under the License.
 
 # Micro service of network service life cycle management.
+
+1. Code structure guide
+   ./           nslcm project root dir files, including license, pom, tox, start/stop scripts, log configuration, etc
+   ./docker     nslcm docker related scripts
+   ./docs       nslcm project documents
+   ./lcm        NS life cycle management
+       ./jobs      nslcm related job
+       ./ns        NS life cycle API&logic
+             ./               API url, const, enum files
+             ./biz            NS LCM management busyness logic files
+             ./data           NS LCM workflow plans
+             ./serializers    API related request and response definitions.
+             ./tests          Test cases
+             ./views          API related NS views
+       ./ns_pnfs   PNF related API&logic in NS layer
+       ./ns_sfcs   SFC related API&logic in NS layer
+       ./ns_vls    VL related API&logic in NS layer
+       ./ns_vnfs   VNF related API&logic in NS layer
+       ./pub       common class, including database model, external micro service API, utils, and config parameters.
+       ./samples   project micro service health check
+       ./swagger   auto-generate nslcm swagger
+       ./workflows workflow related logic
+   ./logs       nslcm log file
+   ./resources  nslcm resources, including database scripts