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 +