From 4861dfae78575d3e61d345eb2ab2d4ba6a4e18d5 Mon Sep 17 00:00:00 2001 From: Marcel Schneider Date: Mon, 27 Jul 2020 10:36:43 +0200 Subject: [PATCH] update readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 8398f22..e0713a5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # gitig - Simple gitignore management [![Build Status](https://drone.schneider-hosting.de/api/badges/schneider/gitig/status.svg)](https://drone.schneider-hosting.de/schneider/gitig) + +`gitig` helps you to manage your .gitignore files more easily. + +When starting a new project, `gitig` will be there for you to download an +example gitignore file for your project [from GitHub](https://github.com/github/gitignore). +Check `gitig list-templates` to find all available templates and download it +with `gitig get {template}`. + +During the project there will be always some files, which need to be ignored. +Don't waste time with opening .gitignore in your editor and add a line there, +just `gitig add {file}` and you're done. When ignoring concrete files, your +shell will be there for you to complete the full filename. + +For more info check the help with `gitig help`