linkaroo - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

package.json

 {
   "name": "linkaroo",
-  "version": "0.1.0",
-  "description": "Like npm link, but \"npm link -> copy -> untar\".",
+  "version": "0.2.0",
+  "description": "Like npm link, but \"npm pack -> copy -> untar\".",
   "files": [
@@ -6,0 +6,0 @@ "cli.sh"

readme.md

 <p align="center">
   <img width="200px" src="https://gitcdn.xyz/repo/loklaan/b7e398d15dff9c59d10a9906d596ad8d/raw/5a0c5271242558eb1bd40e7bef5b1b2b17cfa78c/linkaroo.svg" />
+  <sub><em>"g'day"</em></sub>
 </p>
 
-# linkaroo
+# linkaroooooooooooooooooooooooooooooooooooooooooooo
 
-Is `npm link` or `yarn link` not working for you?
+<p align="center">
+<strong>Has <code>npm link</code> or <code/>yarn link</code> got you down?</strong> 😃😭
+</p>
 
-* Does your linked package have **singleton dependencies**, like `react`?
-* Maybe your code bundler trips up on **symlinks**?
-* Perhaps you're allergic to those commands?
+<p align="center">
+Does your linked package have troublesome <strong>"singleton" dependencies</strong> that begin to double-up, like <code>react</code>?
+</p>
 
-Well, try `linkaroo`.
+<p align="center">
+Maybe your <strong>code bundler</strong> trips up when traversing weird ol' <strong>symlinks</strong>?
+</p>
 
+<p align="center">
+Perhaps you're allergic to or straight up <strong>don't trust</strong> those `link` commands? 🤷‍
+</p>
+
+
+<p align="center">
+...
+</p>
+
+
+<p align="center">
+👉🦘 <strong>Well, give up now and try <code>linkaroo</code>.</strong> 🦘👍😉 wink
+</p>
+
+## Install
+
+```shell
+npm i -g linkaroo
+```
+
 ## Usage
 
-##### First step: pack your package!
+### Step 1.
 
+_Paaaaack your package!_
+
 ```shell
-$ cd my-pkg
+$ cd my-pkg && npm run build
 $ linkaroo pack
-#  Packing "my-pkg"... Packed!
-#
-#  Run the following in your other package or app:
-#
-#    linkaroo link "my-pkg" "/tmp/linkaroo/my-pkg-1.0.0.tgz"
-#    ^ Copied to clipboard. :)
-#
-#  ...Bai!
 ```
 
-##### Second step: "link" your pack! (:
+### Step 2.
 
+_Liiiiiink it up!_
+
 ```shell
 $ cd my-app
-$ linkaroo link "my-pkg" "/tmp/linkaroo/my-pkg-0.1.0.tgz"
-#  Linking "my-pkg"
-#
-#    my-pkg-0.1.0.tgz  ⟹   node_modules/my-pkg
-#
-#  ...Bai!
+$ linkaroo link "my-pkg@1.0.0"
 ```
 
+### Step 3.
+
+_Repeat steps 1 & 2 when `my-pkg` chaaaaanges._
+
+<p align="right">
+👏 <strong>DONE</strong> 👏
+</p>
+<p align="right">
+👏 <strong>DONE</strong> 👏
+</p>
+<p align="right">
+<sub><em>Sponsored* by the Australian Government</em></sub>
+</p>
+<p align="right">
+<sub><em>*: It's not</em></sub>
+</p>
+
 ## Problem Background
 
-To avoid problems while using `npm link` during development of interdependent packages, we can pretend to `publish` and `install` while iterations continue.
+Using `npm/yarn link` can be dissapointing in real life, because our node & bundlers get messed up traversing symlinks; they get stuck and find interdependant packages they were NOT suppose to... 😡
 
+So let's just pretend to `publish` and `install` during local iterations.
+
 That's what these two commands pretend to do:
-1. `pack` will prepare your package for publish, and put the resulting tarball somewhere safe locally.
-2. `link` will unpack that tarball into your other dependants `node_modules/` directory, just like `npm install` does.
+1. `pack` will prepare your package in a tarball (like publishing) and put it somewhere safe on your machine
+2. `link` will unpack that tarball into your other dependants `node_modules/` directory (like a dirty lazy `npm install`)
 
@@ -52,0 +87,0 @@ ## Legal

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7296

increased by43.57%

Number of lines in readme file

92

increased by61.4%

No dependency changes