help

README.md

@@ -1,4 +1,4 @@
-# degit — straightforward project scaffolding
+# @xiangnanscu/degit — straightforward project scaffolding
 
 [![Travis CI build status](https://badgen.net/travis/Rich-Harris/degit/master)](https://travis-ci.org/Rich-Harris/degit)
 [![AppVeyor build status](https://badgen.net/appveyor/ci/Rich-Harris/degit/master)](https://ci.appveyor.com/project/Rich-Harris/degit/branch/master)
@@ -12,14 +12,42 @@
 
 _Requires Node 8 or above, because `async` and `await` are the cat's pyjamas_
 
+# Enhance from origin degit
+
+- `degit some-repo` intead of `degit some-user/some-repo`
+
+When you've already login [gh](https://cli.github.com/) (say, login as `some-user`), you run `degit some-repo` and , it will be the same as `degit some-user/some-repo`
+
+- `--github` flag to create github remote repo from working folder
+
+- `--git` flag to run `git init` in working folder
+
+- `--subdir` flag to fetch sub directory when in gh mode
+
 ## Installation
 
 ```bash
-npm install -g degit
+npm install -g @xiangnanscu/degit
 ```
 
 ## Usage
 
+### gh mode
+assuming you login [gh](https://cli.github.com/) as `user`
+```bash
+# same as degit user/repo
+degit repo
+
+# initialize a github repo `user/somedir` from `user/repo` (commit and push immediately)
+cd somedir && degit repo --github
+
+# or like this
+degit repo somedir --github
+
+# or initialize `user/somedir` from `user/templates-repo/templateA`
+degit templates-repo somedir --github --subdir=templateA
+```
+
 ### Basics
 
 The simplest use of degit is to download the master branch of a repo from GitHub to the current working directory:

help.md

@@ -55,5 +55,8 @@ Options:
   `--verbose`, `-v`  Extra logging
   `--mode=`,   `-m=` Force the mode by which degit clones the repo
                      Valid options are `tar` or `git` (uses SSH)
+  `--github`,   `-g` Create github remote repo from working folder
+  `--git`,      flag to run `git init` in working folder
+  `--subdir=`,  `-s`, Fetch sub directory when in gh mode
 
-See https://github.com/Rich-Harris/degit for more information
+See https://github.com/xiangnanscu/degit for more information

package.json

@@ -1,19 +1,18 @@
 {
 	"name": "@xiangnanscu/degit",
-	"version": "2.21.0",
+	"version": "2.22.0",
 	"engines": {
 		"node": ">=8.0.0"
 	},
 	"description": "Straightforward project scaffolding",
 	"main": "dist/index.js",
 	"bin": {
-		"degit": "degit",
-		"gitt": "degit"
+		"degit": "degit"
 	},
 	"scripts": {
 		"lint": "eslint --color --ignore-path .gitignore .",
 		"dev": "npm run build -- --watch",
-		"build": "rollup -c",
+		"build": "rollup -c;cp help.md dist",
 		"prerc": "npm --no-git-tag-version version minor",
 		"rc": "npm run push",
 		"commit": "git add . && git commit -am ",
@@ -23,7 +22,7 @@
 	},
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/Rich-Harris/degit.git"
+		"url": "git+https://github.com/xiagnnanscu/degit.git"
 	},
 	"keywords": [
 		"scaffolding",
@@ -33,9 +32,9 @@
 	"author": "Rich Harris",
 	"license": "MIT",
 	"bugs": {
-		"url": "https://github.com/Rich-Harris/degit/issues"
+		"url": "https://github.com/xiagnnanscu/degit/issues"
 	},
-	"homepage": "https://github.com/Rich-Harris/degit#readme",
+	"homepage": "https://github.com/xiagnnanscu/degit#readme",
 	"devDependencies": {
 		"@rollup/plugin-commonjs": "18.0.0",
 		"@rollup/plugin-node-resolve": "11.2.1",