Skip to content

Commit cb268da

Browse files
authored
Merge pull request #355 from indiegenus/readme
Cleaned Up the README File
2 parents bc969fa + 0c52729 commit cb268da

File tree

1 file changed

+30
-26
lines changed

1 file changed

+30
-26
lines changed

README.md

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,66 +12,70 @@
1212

1313
## About `kool`
1414

15-
**kool** is a CLI tool that helps bringing down to earth the complexities of modern software development environments - making them lightweight, fast and reproduceable. It takes off the complexity and learning curve of _Docker_ and _Docker Compose_ for local environments, as well as offers a highly simplified interface for leveraging _Kubernetes_ cloud deployment for staging and production deployments.
15+
**Kool** is a CLI tool that brings the complexities of modern software development environments down to earth - making these environments lightweight, fast and reproducible. It reduces the complexity and learning curve of _Docker_ and _Docker Compose_ for local environments, and offers a simplified interface for using _Kubernetes_ to deploy staging and production environments to the cloud.
1616

17-
Get your local development environment up and running easy and quickly, put time and effort on making a great application, and then leverage the Kool cloud for deploying and sharing your work with the world! This tool is suitable for single developers or large teams, powering them with a simple start and still provides all flexibility the DevOps team needs to tailor up everything.
17+
**Kool** gets your local development environment up and running easily and quickly, so you have more time to build a great application. When the time is right, you can then use Kool Cloud to deploy and share your work with the world!
1818

19-
To learn more [check out our website kool.dev](https://kool.dev).
19+
**Kool** is suitable for solo developers and teams of all sizes. It provides a hassle-free way to handle the Docker basics and immediately start using containers for development, while simultaneously guaranteeing no loss of control over more specialized Docker environments.
20+
21+
[Learn more at kool.dev](https://kool.dev).
2022

2123
## Installation
2224

23-
Requirements: Kool is powered by [Docker](https://docs.docker.com/get-docker/) so you need to have it already installed on your machine. If you haven't already, please [get Docker first](https://docs.docker.com/get-docker/).
25+
Requirements: Kool is powered by [Docker](https://docs.docker.com/get-docker/). If you haven't done so already, you first need to [install Docker and the kool CLI](https://kool.dev/docs/getting-started/installation).
2426

25-
#### For Linux or MacOS
27+
### For Linux and macOS
2628

27-
In order to obtain `kool` under **Linux** and **MacOS** run the following script:
29+
Install **kool** by running the following script. It will download the latest **kool** binary from [https://github.com/kool-dev/kool/releases](https://github.com/kool-dev/kool/releases), and save it in your `/usr/local/bin` folder.
2830

2931
```bash
3032
curl -fsSL https://kool.dev/install | bash
3133
```
3234

33-
#### For Windows
35+
### For Windows
3436

35-
Download and run the latest installer from our releases artifacts [here](https://github.com/kool-dev/kool/releases).
37+
Install **kool** by downloading the appropriate installer from [https://github.com/kool-dev/kool/releases](https://github.com/kool-dev/kool/releases). At the bottom of the release notes for the latest version, expand the list of "Assets", and download the installer that matches your machine.
3638

37-
## Getting started
39+
## Getting Started
3840

39-
It is easy to get started leveraging `kool`. Check out our [getting started documentation for a generic PHP web app](https://kool.dev/docs/getting-started/starting-new-project).
41+
It's really easy to get started with `kool`. Check out our [Getting Started documentation for a generic PHP web app](https://kool.dev/docs/getting-started/starting-new-project).
4042

41-
To help getting you started on real life applications, we've built presets as a starting point for some popular stacks and frameworks.
43+
To help you start building real-world applications, we've created Kool Presets as a starting point for some popular frameworks and stacks.
4244

43-
#### Available Presets
45+
### Available Presets
4446

47+
- [AdonisJs](docs/2-Presets/AdonisJs.md)
48+
- [Hugo](docs/2-Presets/Hugo.md)
4549
- [Laravel](docs/2-Presets/Laravel.md)
46-
- [Symfony](docs/2-Presets/Symfony.md)
47-
- [Wordpress](docs/2-Presets/Wordpress.md)
48-
- [Adonis](docs/2-Presets/Adonis.md)
4950
- [NestJS](docs/2-Presets/NestJS.md)
50-
- [NextJS](docs/2-Presets/NextJS.md)
51+
- [Next.js](docs/2-Presets/NextJS.md)
52+
- [Node.js](docs/2-Presets/NodeJS.md)
5153
- [NuxtJS](docs/2-Presets/NuxtJS.md)
52-
- [Hugo](docs/2-Presets/Hugo.md)
54+
- [PHP](docs/2-Presets/PHP.md)
55+
- [Symfony](docs/2-Presets/Symfony.md)
56+
- [WordPress](docs/2-Presets/WordPress.md)
5357

54-
> In case you miss your favorite framework of choice from the list above, please let us know in an issue or feel free to open up a PR for it!
58+
> If you don't see your favorite framework in the list above, please let us know by creating a GitHub issue, or, better yet, feel free to submit a PR!
5559
5660
## Documentation
5761

58-
You can check the documentation at [**https://kool.dev/docs**](https://kool.dev/docs) or at [docs/](docs/).
62+
Read the documentation at [**https://kool.dev/docs**](https://kool.dev/docs) or [docs/](docs/).
5963

6064
## Community, Contributing and Support
6165

62-
You are most welcome to contribute and help in our mission of making software development *kool* for everyone.
66+
We invite you to contribute and help in our mission of making software development *kool* for everyone.
6367

64-
- [Issues](/issues) are the primary channel for bringing up and tracking issues or proposals.
65-
- [Kool community on Slack](https://kool.dev/slack) is the a great place to get help and reach Kool developers.
66-
- Check out our [contributing guide](CONTRIBUTING.md) for getting involved.
68+
- [Issues](/issues) are the primary channel for bringing issues and proposals to our attention.
69+
- [Kool on Slack](https://kool.dev/slack) is a great place to get help and interact with Kool developers.
70+
- Learn how to get involved by reading our [contributing guide](CONTRIBUTING.md).
6771

68-
### Roadmap
72+
## Roadmap
6973

70-
We have been working in a loosely defined but clear roadmap. You can check it out [in our blog Roadmap page](https://blog.kool.dev/page/roadmap).
74+
Our work is organized according to a loosely defined but clear roadmap. Check out [the Roadmap page](https://blog.kool.dev/page/roadmap) on [our blog](https://blog.kool.dev/).
7175

7276
## Security
7377

74-
If you find security issue please let us know ahead of making it public like in an issue so we can take action as soon as possible. Please email the concern to `contact@kool.dev`.
78+
If you find a security issue, please let us know right away, before making it public, by creating a GitHub issue. We'll take action as soon as possible. You can email questions and concerns to `contact@kool.dev`.
7579

7680
## License
7781

0 commit comments

Comments
 (0)