diff --git a/README.md b/README.md index b43601a..3c20d35 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,28 @@ # Kubernetes-minikube +A Kubernetes Minikube script that installs docker, kubectl and minikube for you. -A Kubernetes Minikube script that installs docker, kubectl and minikube for you. +## Quick Start +Start installation: -To ensure the system is fully patched the script will run **apt-update update && upgrade**, then it will proceed with installing the following packages: + $ ./install.sh -- Docker:Latest -- Bash-completion -- Kubernetes:Stable -- Minikube:latest +If your not able to start **./install.sh** it could be that the file is missing the **Execute permission**: - After the packages are installed it will run **minikube start --driver=docker** + chmod +x ./install.sh -## Useful Links - -| Project | Links | -|------------|------------------------------------| -| Docker | https://docs.docker.com/ | -| Kubernetes | https://kubernetes.io/docs/home/ | -| Minikube | https://minikube.sigs.k8s.io/docs/ | +### What will the script install? +- Docker : Latest +- Kubernetes : Stable +- Minikube : Latest + - After installation you will be prompted the option to start minikube. + +### Want to add more programs to the script? +The script will run **source** for every file ending with **.sh** in the **./scripts/*** folder. + +## Documentation links + +| Project | Links | +|-----------|-----------------------------------| +| Docker | https://docs.docker.com/ | +| Kubernetes| https://kubernetes.io/docs/home/ | +| Minikube | https://minikube.sigs.k8s.io/docs/| \ No newline at end of file