From c6eb44572f1f77f6c5d27c7be89d439fb69908eb Mon Sep 17 00:00:00 2001 From: pritesh-patel Date: Thu, 22 Aug 2019 11:27:13 -0700 Subject: [PATCH] update readme --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c869c5da8..c22529705 100644 --- a/README.md +++ b/README.md @@ -16,15 +16,17 @@ Based on specified config it will generate: It will also live with your project, when you add a new service to the config it will generate everything needed for that new service. +## What does it generate? + The generation will create a folder with 3 repos within it. * A rep for the IDL's * A repo that has the generated artifacts from the IDL * A repo that implements the interfaces of the generated artifacts -NOTE: It only creates the folders for these repos, you will still need to create the git repos on your respected platform. Aswell as initialise each folder as a git repo and push when there have been changes. (if there is a strong desire we can look at how to make this process easier.) +`NOTE: It only creates the folders for these repos, you will still need to create the git repos on your respected platform. Aswell as initialise each folder as a git repo and push when there have been changes. (if there is a strong desire we can look at how to make this process easier.)` -The dev process: +## The development cycle 1) Setup sprout config & run generation 2) Start adding your desired methods to the protobuf files generated