📝 Update README

Author: nkmr-jp

.github/workflows/release.yml

@@ -26,11 +26,11 @@ jobs:
           yq --version
       - name: Install gitmoji-semver
         run: |
-          git clone https://github.com/nkmr-jp/gitmoji-semver -b v1.6.0
+          git clone https://github.com/nkmr-jp/gitmoji-semver -b develop
       - name: Generate semantic-release configs
         working-directory: ./gitmoji-semver
         run: |
-          make scaffold V=v3.0.0 F=../.semver.yml O=..
+          make scaffold V=v3.0.0 F=../.semver.yml O=.. T=simple
       - name: Release
         working-directory: ./.release
         env:

Makefile

@@ -5,8 +5,8 @@ F=.semver.yml
 SEMVER_FILE=$(F)
 O=./
 OUT_DIR=$(O)
-M=""
-MODE=$(M)
+T=""
+TEMPLATE_TYPE=$(T)
 
 BASE_FILE=https://raw.githubusercontent.com/carloscuesta/gitmoji/$(GITMOJI_VERSION)/src/data/gitmojis.json
 
@@ -37,13 +37,13 @@ help:
 	@echo "    V=<version>		$(BLUE)Specify the base gitmoji version$(RESET)"
 	@echo "    F=<filepath>	$(BLUE)Specify .semver.yml file path$(RESET)"
 	@echo "    O=<output dir>	$(BLUE)Specify semantic-release setting files output directory$(RESET)"
-	@echo "    M=<mode>	$(BLUE)Specify release template MODE 'default or simple'$(RESET)"
+	@echo "    T=<template type>	$(BLUE)Specify release template type 'default or simple'$(RESET)"
 	@echo
 	@echo "$(GREEN)Examples:$(RESET)"
 	@echo "    make gen V=v3.0.0 F=./.semver.yml"
 	@echo "    make list"
 	@echo "    make scaffold V=v3.0.0 F=./.semver.yml O=./.playground"
-	@echo "    make scaffold V=v3.0.0 F=./.semver.yml O=./.playground M=simple"
+	@echo "    make scaffold V=v3.0.0 F=./.semver.yml O=./.playground T=simple"
 	@echo
 
 # Generate gitmojis.json with semver field
@@ -91,13 +91,13 @@ list:
 scaffold: gen
 	@echo
 	@echo "$(PURPLE)# SCAFFOLD: Generate semantic-release setting files$(RESET)"
-	node gen-release-template.js $(MODE)
+	node gen-release-template.js $(TEMPLATE_TYPE)
 	mkdir -p $(OUT_DIR)/.release
 	cp -a ./semantic-release-template/. $(OUT_DIR)/.release
 	cp ./build/dist/release-template.hbs $(OUT_DIR)/.release
 	cp ./build/dist/gitmojis.json $(OUT_DIR)/.release
 	cp ./build/src/semver.json $(OUT_DIR)/.release
-ifeq ($(MODE),simple)
+ifeq ($(TEMPLATE_TYPE),simple)
 	cp $(OUT_DIR)/.release/commit-template-simple.hbs $(OUT_DIR)/.release/commit-template.hbs
 else
 	cp $(OUT_DIR)/.release/commit-template-default.hbs $(OUT_DIR)/.release/commit-template.hbs

README.md

@@ -18,6 +18,7 @@
 <!-- code_chunk_output -->
 
 - [Features](#features)
+  - [Release template type](#release-template-type)
 - [How to use in Mac](#how-to-use-in-mac)
   - [Install](#install)
   - [Usage](#usage)
@@ -32,17 +33,26 @@
 
 <!-- /code_chunk_output -->
 
-
 ## Features
-- :smile: A simple script to add the semver field to [gitmojis.json](https://github.com/carloscuesta/gitmoji/blob/master/src/data/gitmojis.json).
+
+- :smile: A simple script to add the semver field
+  to [gitmojis.json](https://github.com/carloscuesta/gitmoji/blob/master/src/data/gitmojis.json).
     - Generate the files `gitmojis.json` with the semver field added.
-- :rocket: You can easily do Semver Release automatically by just committing with gitmoji. ( [like this](https://github.com/nkmr-jp/gitmoji-semver/releases) )
-  - Automate versioning and release with GithubActions and [semantic-release](https://github.com/semantic-release/semantic-release).
+- :rocket: You can automatically and easily release by semver (semantic versioning) just by
+  committing with Gitmoji. ( [like this](https://github.com/nkmr-jp/gitmoji-semver/releases) )
+    - Automate versioning and release with GithubActions
+      and [semantic-release](https://github.com/semantic-release/semantic-release).
 
+### Release template type
+
+| [default](https://github.com/nkmr-jp/gitmoji-semver-sample/releases/tag/v2.4.0) | [simple](https://github.com/nkmr-jp/gitmoji-semver-sample/releases/tag/v2.3.0) |
+| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
+| ![img_2.png](img_2.png)                                                         | ![img_1.png](img_1.png)                                                        |
 
 ## How to use in Mac
 
 ### Install
+
 Require `curl`, `jq`, `yq` and `node` command.
 
 ```sh
@@ -60,17 +70,19 @@ git clone https://github.com/nkmr-jp/gitmoji-semver
 ```
 
 ### Usage
+
 ```sh
 cd ./gitmoji-semver
 make help
 ```
 
-<img src="img.png" width=800>
+<img src="img.png" width=600>
 
 ## How to use in GithubActions ( only 3 minutes )
 
-The following steps will automate versioning and releasing with gitmoji using GithubActions.
-You only need to add two files, and you're ready to go. Feel free to try it out in your own Github Repository. 
+The following steps will automate versioning and releasing with gitmoji using GithubActions. You
+only need to add two files, and you're ready to go. Feel free to try it out in your own Github
+Repository.
 
 ### Step 1: Add `.semver.yml` to your Repository root
 
@@ -101,7 +113,7 @@ semver:
     - construction  # Work in progress.
 ```
 
-### Step 2: Add `release.yml` to `.github/workflows/` 
+### Step 2: Add `release.yml` to `.github/workflows/`
 
 ```yml
 # .github/workflows/release.yml
@@ -149,6 +161,7 @@ jobs:
 ```
 
 ### Step 3: Commit and Push
+
 ```sh
 git add .
 git commit -m ":construction_worker: Add Release settings by https://github.com/nkmr-jp/gitmoji-semver"
@@ -159,7 +172,7 @@ git push
 
 #### If you want to run locally
 
-There will not be an actual Release. You can see how it works. 
+There will not be an actual Release. You can see how it works.
 
 ```sh
 brew install act
@@ -179,10 +192,10 @@ act -P ubuntu-18.04=nektos/act-environments-ubuntu:18.04 # ※ 16GB docker image
 
 👤 **nkmr-jp**
 
-
 ## Show your support
 
 Give a ⭐️ if this project helped you!
 
 ***
-_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_
+_This README was generated with ❤️
+by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_