Merge pull request #5 from jack5341/master

Updated Documentation and Integrated git-cliff

.gitignore

@@ -1,2 +1,3 @@
 
 dist/
+/.DS_Store/

README.md

@@ -0,0 +1,55 @@
+<p align="center">
+  <img height="300" src="https://user-images.githubusercontent.com/53150440/135754337-e9a12311-9eb0-4de6-8d19-348341f3b200.png"/><br/>
+  <a>
+        <img src="https://img.shields.io/github/v/release/theykk/git-switcher?style=flat&labelColor=1C2C2E&color=abc3d6&logo=GitHub&logoColor=white">
+  </a>
+  <a>
+        <img src="https://img.shields.io/github/license/theykk/git-switcher?style=flat&labelColor=1C2C2E&color=abc3d6&logoColor=white">
+  </a>
+  <a>
+        <img src="https://img.shields.io/github/stars/theykk/git-switcher?style=flat&labelColor=1C2C2E&color=abc3d6&logoColor=white">
+  </a>
+
+</p>
+
+# Git Profile Switcher
+
+Switch between your git profiles easily
+
+## Install
+
+With Brew
+
+```
+brew install theykk/tap/git-switcher
+```
+
+With golang
+
+```
+go get github.com/theykk/git-switcher@latest
+```
+
+## Switch Profile
+
+![Switcher](https://user-images.githubusercontent.com/53150440/135753964-94d83bf5-597c-4983-b0cf-5da6f12e6c7c.gif)
+
+## Create Profile
+
+![Create](https://user-images.githubusercontent.com/53150440/135753994-aa60050b-020c-422b-9fed-0a266f550dda.gif)
+
+## Delete Profile
+
+![Delete](https://user-images.githubusercontent.com/53150440/135754022-55268cc5-9979-4802-8a93-0e09c158cd6c.gif)
+
+## Rename Profile
+
+![Rename](https://user-images.githubusercontent.com/53150440/135754365-f8e347d9-89e1-4a34-a131-edeb7e004047.gif)
+
+## Feedback
+
+If you have any feedback, please reach out to us at [email protected]
+
+## License
+
+[Apache-2.0](https://choosealicense.com/licenses/apache-2.0/)

cliff.toml

@@ -0,0 +1,53 @@
+# configuration file for git-cliff (0.1.0)
+
+[changelog]
+# changelog header
+header = """
+# Changelog
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://tera.netlify.app/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits %}
+        - {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespaces from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+
+[git]
+# allow only conventional commits
+# https://www.conventionalcommits.org
+conventional_commits = true
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^feat", group = "Features"},
+    { message = "^fix", group = "Bug Fixes"},
+    { message = "^doc", group = "Documentation"},
+    { message = "^perf", group = "Performance"},
+    { message = "^refactor", group = "Refactor"},
+    { message = "^style", group = "Styling"},
+    { message = "^test", group = "Testing"},
+    { message = "^chore\\(release\\): prepare for", skip = true},
+    { message = "^chore", group = "Miscellaneous Tasks"},
+    { body = ".*security", group = "Security"},
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# glob pattern for matching git tags
+tag_pattern = "v[0-9]*"
+# regex for skipping tags
+skip_tags = "v0.1.0-beta.1"