build-this-branch - npm Package Compare versions

Comparing version 1.1.0 to 1.2.0

package.json

 {
 	"name": "build-this-branch",
-	"version": "1.1.0",
+	"version": "1.2.0",
 	"description": "Script to automate creating built branches",
@@ -5,0 +5,0 @@ "keywords": [

README.md

 # build-this-branch
 
 <p align="center">
-	<img src=".github/screenshot.png" width="600">
+	<img src=".github/demo.gif" width="560">
 </p>
@@ -19,3 +19,3 @@
 
-> **⚠️ Warning:** This command will force-push to the remote branch `built/<current branch>`. Please make sure there are no unsaved changes there. You can configure the built branch name with `--built-branch <branch name>`.
+> **⚠️ Warning:** This command will force-push to the remote branch `built/<current branch>`. Make sure there are no unsaved changes there. You can configure the built branch name with `--built-branch <branch name>`.
 
@@ -34,3 +34,3 @@
 | `-c, --build-command <command>` | The command to build the branch. (default: `npm run build`) |
-| `-b, --built-branch <branch name>` | The name of the built branch. Defaults to prefixing "built/" to the current branch. |
+| `-b, --built-branch <branch name>` | The name of the built branch. Defaults to prefixing "built/" to the current branch or tag name. |
 | `-r, --remote <remote>` | The remote to push to. (default: `origin`) |
@@ -45,5 +45,6 @@ | `-d, --dry` | Dry run mode. Will not build, commit, or push to the remote. |
 
-In projects that build from source files, a _built branch_ is a branch that contains built assets so it can be installed with [npm](https://docs.npmjs.com/cli/v8/commands/npm-install#:~:text=npm%20install%20%3Cgithubname%3E%2F%3Cgithubrepo%3E%5B%23%3Ccommit-ish%3E%5D):
+In projects that build from source files, a _built branch_ is a branch that contains built assets so it can be installed with [npm](https://docs.npmjs.com/cli/v8/commands/npm-install#:~:text=npm%20install%20%3Cgithubname%3E%2F%3Cgithubrepo%3E%5B%23%3Ccommit-ish%3E%5D) when pushed to GitHub:
 
 ```sh
+# Installs from github.com/organization/repository/tree/built-branch
 npm install 'organization/repository#built-branch'
@@ -60,5 +61,5 @@ ```
 2. Create a new branch with the `built/` namespace
-2. Detects npm publish files and commits them to the new branch
-4. Force pushes to remote
+3. [Detects](https://github.com/npm/npm-packlist) and only commits npm publish files to the new branch
+4. Force pushes up to remote
 5. Deletes local built branch
-6. Prints the installation command to install from the built branch
+6. Prints the installation command for the built branch

No alert changes

Improved metrics

Total package byte prevSize

1228356

increased by0.02%

Number of lines in readme file

62

increased by1.64%

Worsened metrics

Lines of code

4933

decreased by-0.02%

No dependency changes