improve README.md and examples

Author: Fabian Martinez

README.md

@@ -1,38 +1,69 @@
-## Appctl
+# Appctl
+
 ### Unified developer experience across all your projects
 
-Do you write your own build scripts or do you prefer to use `make`? Are you too lazy to write your own Makefiles? do you even know what `make` is? Do you suffer of having several projects written with different technologies and you always struggle to remember how to build/test/package each one? 
+Are you too lazy to write your own build scripts or your own Makefiles? Do you even know what `make` is? Do you suffer from having several projects written with different technologies and you always struggle to remember how to build/test/package each one?
+
+This project aims to provide a simple and unified development experice across all your projects
 
-No worries `appctl` knows well about `make` and Makefiles and leverages it for you so you 
-have the simplest build chain accross all your projects, works for Java, Go,.. no matter what is the underline technology, it's actually indiferent to `appctl`. You just specify what kind of app you are working with and `appctl` manages it for you so you don't have to remember the exact commands to build each one of your projects.
+## What does `appctl` do?
 
-You could just write Makefiles following your own guidelines in all your projects and you would already have a unified developer experience. But because you are too lazy and you won't do that here is `appctl` to do that for you.
+Appctl executes your most common workflows in your development process through a simple and unified CLI across all your projects
 
-I hope you like it
+Actually this tool does nothing, your typical build tools do the job. You will use npm for nodejs apps, maven for java, docker for container images, ... Whatever tool, but `appctl` will invoke them for you.
+You may even forget about all of that but only remember to execute `appctl build`
 
-### Usage
+## Try it
 
-First install the binary
+To install from source, only pre-requisite is golang >= 1.13
 ```
 make install
 ```
 
-Then you can use it :)
-
-Examples:
-
+Or just download and install it with the `install.sh` script
 ```
-appctl build examples/simple-app/
+curl -sfL https://raw.githubusercontent.com/famartinrh/appctl/master/install.sh | sh -
 ```
 
-or
+There are some examples of applications using `appctl` under the folder `examples`
 
+#### Build, test and create a container image of Quarkus app (Java)
 
 ```
 cd examples/simple-app
 
+appctl status
+
+appctl build
+
+docker images | grep simple-app
+
+cat app.yaml
+```
+
+#### Microservices application using nodejs
+
+```
+cd examples/microservices-example
+
+appctl status
+
 appctl build
+
+docker images | grep appctl-
+
+cat app.yaml
+
+cat api-gateway/app.yaml
 ```
 
-https://www.gnu.org/software/make/manual/make.html
+<!-- ## How does it work? -->
+
+
+
+<!-- https://www.gnu.org/software/make/manual/make.html -->
+
+
+
+
 

appctl

@@ -104,6 +104,7 @@ func initializeConfig(cmd *cobra.Command) error {
 				if err != nil {
 					return err
 				}
+				os.MkdirAll(filepath.Dir(appctlConfigFilePath), os.ModePerm)
 				err = ioutil.WriteFile(appctlConfigFilePath, bytes, 0664)
 				if err != nil {
 					return err

cmd/root.go

@@ -5,7 +5,7 @@ metadata:
   annotations:
     description: Simple app using Quarkus Java framework
     author: the appctl authors
-    organization: famargon
+    organization: my-org
 spec:
   # all recipes from one template
   template: quarkus-jvm

examples/example-app.yaml

@@ -3,10 +3,13 @@ apiVersion: appctl.io/v1
 metadata:
   name: api-gateway
   annotations:
-    author: Fabian Martinez
+    author: appct-examples-author
     description: api-gateway description
-    organization: famargon
+    organization: my-org
 spec:
   templates:
   - nodejs
   - docker
+  vars:
+    - name: CONTAINER_IMAGE_NAME
+      value: appctl-api-gateway:latest

examples/microservices-example/api-gateway/app.yaml

@@ -3,9 +3,9 @@ apiVersion: appctl.io/v1
 metadata:
   name: microservices-example
   annotations:
-    author: Fabian Martinez
+    author: appct-examples-author
     description: microservices-example description
-    organization: famargon
+    organization: my-org
 spec:
   recipes:
     build:
@@ -14,7 +14,7 @@ spec:
         recipes:
           - nodejs/build
           - docker/build
-          - push
+          # - push # uncomment to run docker push on all projects
         apps:
           - api-gateway
           - fruits-service

examples/microservices-example/app.yaml

@@ -3,10 +3,13 @@ apiVersion: appctl.io/v1
 metadata:
   name: fruits-service
   annotations:
-    author: Fabian Martinez
+    author: appct-examples-author
     description: fruits-service description
-    organization: famargon
+    organization: my-org
 spec:
   templates:
   - nodejs
   - docker
+  vars:
+    - name: CONTAINER_IMAGE_NAME
+      value: appctl-fruits-service:latest

examples/microservices-example/fruits-service/app.yaml

@@ -3,13 +3,16 @@ apiVersion: appctl.io/v1
 metadata:
   name: users-service
   annotations:
-    author: Fabian Martinez
+    author: appct-examples-author
     description: users-service description
-    organization: famargon
+    organization: my-org
 spec:
   templates:
   - nodejs
   - docker
+  vars:
+    - name: CONTAINER_IMAGE_NAME
+      value: appctl-users-service:latest
   recipes:
     all:
       - name: nodejs

examples/microservices-example/users-service/app.yaml

@@ -5,22 +5,19 @@ metadata:
   annotations:
     author: simple-app author
     description: simple-app description
-    organization: famargon
+    organization: simple-app-org
 spec:
   template: quarkus-jvm
   vars:
-    - name: CONTAINER_IMAGE_TAG
-      value: latest
+    - name: CONTAINER_IMAGE_NAME
+      value: simple-app:latest
   recipes:
     overload:
       - template: quarkus-jvm
         recipe: build
         vars:
-          - name: CONTAINER_IMAGE_TAG
-            value: appctl-test
+          - name: CONTAINER_IMAGE_NAME
+            value: simple-app-appctl-test:latest
     push: 
       - template: docker
-        recipe: push
-        vars:
-          - name: CONTAINER_IMAGE_TAG
-            value: appctl-test
+        recipe: push

examples/simple-app/app.yaml

@@ -1 +1 @@
-quay.io/famargon/simple-app:appctl-test
+simple-app:latest