From c4161edfe551aec2db35f9521b4ff1f2b10260b3 Mon Sep 17 00:00:00 2001 From: fabriciojs Date: Mon, 26 Oct 2020 15:29:23 -0300 Subject: [PATCH 1/4] update docs install / update --- docs/1-Getting-Started/1-Installation.md | 28 ++++++++++++++++-------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/docs/1-Getting-Started/1-Installation.md b/docs/1-Getting-Started/1-Installation.md index a25f49f6..4c554b70 100644 --- a/docs/1-Getting-Started/1-Installation.md +++ b/docs/1-Getting-Started/1-Installation.md @@ -1,29 +1,39 @@ +## Installation + ### Requirements -Kool is powered by **[Docker](https://docs.docker.com/get-docker/)** and **[Docker Compose](https://docs.docker.com/compose/install/)**, you need to have it installed on your machine. +Kool is powered by **[Docker](https://docs.docker.com/get-docker/)** and **[Docker Compose](https://docs.docker.com/compose/install/)**, you need to have them installed on your machine. -### Installation +### For Linux and MacOS To install **kool** simply run the following script. -```bash -curl -fsSL https://raw.githubusercontent.com/kool-dev/kool/master/install.sh | bash -``` - -In case it fails due to permission then run it using sudo: - ```bash curl -fsSL https://raw.githubusercontent.com/kool-dev/kool/master/install.sh | sudo bash ``` All this script will do is download latest kool bin from https://github.com/kool-dev/kool/releases for your OS and put in your `/usr/local/bin` folder. -## For Windows +### For Windows Download the installer [here](https://github.com/kool-dev/kool/releases) To check if everything looks good simply run **kool** to see the list of available commands. +## Updating kool to a newer version + +When a new version is released you can obtain it with the builtin command: + +```bash +sudo kool self-update +``` + +This will check the latest realease and download/install it case there is a newer version. + +**Alternative**: in order to get a new release you can always repeat the installation steps provided above as well, which should get you the latest version. + +> We suggest that you *start* and sign up for new releases notifications on our Github main repository so you always will stay up to date with our latest features! + ## Autocompletion To load completions: From f754df6662621e42fdc29754e89cab58aaa7d86e Mon Sep 17 00:00:00 2001 From: fabriciojs Date: Mon, 26 Oct 2020 15:29:34 -0300 Subject: [PATCH 2/4] self-update docs --- docs/1-Getting-Started/1-Installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/1-Getting-Started/1-Installation.md b/docs/1-Getting-Started/1-Installation.md index 4c554b70..f5639561 100644 --- a/docs/1-Getting-Started/1-Installation.md +++ b/docs/1-Getting-Started/1-Installation.md @@ -20,9 +20,9 @@ Download the installer [here](https://github.com/kool-dev/kool/releases) To check if everything looks good simply run **kool** to see the list of available commands. -## Updating kool to a newer version +## Updating to a newer version -When a new version is released you can obtain it with the builtin command: +When a new version is released you can obtain it with the builtin command `self-update`: ```bash sudo kool self-update From e5826d391c6b3b06a01910ffb7545defe9e62a67 Mon Sep 17 00:00:00 2001 From: fabriciojs Date: Mon, 26 Oct 2020 15:35:21 -0300 Subject: [PATCH 3/4] update readme - contributing --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7a6a7d52..c9c61bb1 100644 --- a/README.md +++ b/README.md @@ -87,11 +87,20 @@ You can see projects using it here: https://github.com/kool-dev/examples ## Contributing -Like what you see? You are most welcome to contribute! We are working in a backlog of issues, feel free to browse through and enter discussions or get to work! +You are most welcome to contribute! There are issues with `good-first-issue` label, feel free to browse through and enter discussions or get to work! The flow is not written in stone, so you may go ahead and fork, code and PR with clear and direct communication on the feature/improvement or fix you developed. -PS: our main pain point at this moment is the lack of testing. Might be a great starting point. +### Roadmap + +We have been working in a loosely defined but clear roadmap: + +- Recently: we focused on tests coverage for moving forward condifently; we got from 0 to 90% coverage in a couple of weeks! *check!* +- Currently focusing in: improving overall UX and stabilize features - error messages, progress display, output control, presets creation, getting started, etc... +- Next steps: + - Continunously improve tests coverage; + - Continunously improve UX based on usage feedbacks; + - Expand features (Proposal issues); ### Lint, formatting and tests From 48cb5afe3fe626e7d50f58383d1f9dbd2fb8862f Mon Sep 17 00:00:00 2001 From: fabriciojs Date: Mon, 26 Oct 2020 15:38:03 -0300 Subject: [PATCH 4/4] link good first issues --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c9c61bb1..ed911fec 100644 --- a/README.md +++ b/README.md @@ -87,9 +87,9 @@ You can see projects using it here: https://github.com/kool-dev/examples ## Contributing -You are most welcome to contribute! There are issues with `good-first-issue` label, feel free to browse through and enter discussions or get to work! +You are most welcome to contribute! There are issues with [`good first issue`](https://github.com/kool-dev/kool/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label, feel free to browse through and enter discussions or get to work! -The flow is not written in stone, so you may go ahead and fork, code and PR with clear and direct communication on the feature/improvement or fix you developed. +The workflow is not written in stone, so you may go ahead and fork, code and PR with clear and direct communication on the feature/improvement or fix you developed. ### Roadmap