Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`](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.

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

Expand Down
28 changes: 19 additions & 9 deletions docs/1-Getting-Started/1-Installation.md
Original file line number Diff line number Diff line change
@@ -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 to a newer version

When a new version is released you can obtain it with the builtin command `self-update`:

```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:
Expand Down