From 7cfbe9138621a3bbc2b787f19673b3c48e0f7257 Mon Sep 17 00:00:00 2001 From: Samuel Fabrizio Date: Tue, 6 Dec 2016 09:35:04 -0300 Subject: [PATCH] [ADD] readme: add descriptions. --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 893ce34..5e37525 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,42 @@ [![Turbo Commit](https://img.shields.io/badge/Turbo_Commit-on-3DD1F2.svg)](https://github.com/labs-js/turbo-commit/blob/master/CONVENTION.md) # turbo-git-config -Config package for turbo-git +**Turbo git config** -> Parser & Utils for commit conventions. + +#### This lib is part of the [Turbo Git](https://github.com/labs-js/turbo-git) -> Making your git even more awesome 😎🙌 + +## how to use it: + +``` +npm install --save turbo-git-config +``` + +And then from the code when you need use it: + +### Config Parser +``` +var configParser = require('turbo-git-config').parser +``` + +### Utils +``` +var utils = require('turbo-git-config').utils +``` + +### Config Parser Methods: + +- getTagsFormat +- getCommitConf +- getProperty +- getLogCommand +- getCommitPromptText +- getConfigFilesData + + +### Utils Methods: + +- checkGitRepoExistence +- checkLocalConfigFile +- getGitRepoMainPath +- showError + pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy