Skip to content

Commit b6b09ff

Browse files
committed
Improve Taskfile description
1 parent 72d0c29 commit b6b09ff

File tree

5 files changed

+6
-13
lines changed

5 files changed

+6
-13
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Taskfile
22

3-
A Taskfile adds a list of commonly used tasks in a quick overview in your CLI. Enable your users to quickly setup a
4-
project and run common tasks via super simple commands.
3+
A `./Taskfile` is a task runner in plain and easy [Bash](https://nl.wikipedia.org/wiki/Bash). It adds a list of available tasks to your project.
54

65
![CLI Taskfile preview](./images/cli-preview.gif)
76

87
## Why
98

10-
- Automate your most common tasks (updating, starting development, building, etc...)
11-
- Have a uniform method to run tasks for all your pojects
12-
- No project specific knowledge is required to get things done
9+
- Works on any OS (any bash terminal)
10+
- A uniform way to run your projects
11+
- Very easy to use
12+
- Automate your most common tasks (updating, starting, building, etc...)
13+
- Easy to understand and maintain
1314

1415
# Create your own taskfile
1516

section/docker.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
[Overview](../../README.md)[Usefull tasks](../usefull-tasks.md) ➤ Docker
2-
31
# Docker
42

53
An absolute must if your project is running via docker locally.

section/github.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
[Overview](../../README.md)[Usefull tasks](../usefull-tasks.md) ➤ GitHub
2-
31
# GitHub
42

53
If you use GitHub and want an easy way to check out Pull Requests locally,

section/gitlab.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
[Overview](../../README.md)[Usefull tasks](../usefull-tasks.md) ➤ GitLab
2-
31
# GitLab
42

53
If you use GitLab and want an easy way to check out Merge Requests locally,

section/project.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
[Overview](../../README.md)[Usefull tasks](../usefull-tasks.md) ➤ Project
2-
31
# Project section
42

53
A project section can be very usefull to quickly get your project up and running,

0 commit comments

Comments
 (0)