parallax-react-js - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "parallax-react-js",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A libary for managing scroll speed of different components in react.",
@@ -5,0 +5,0 @@ "scripts": {

README.md

 # parallax-react-js
 
 ## Table of contents
-1. [Introduction](https://github.com/juliuswaldmann/parallax-react/blob/main/README.md#introduction)
-   * [Description](https://github.com/juliuswaldmann/parallax-react/blob/main/README.md#descriptiom)
-   * [Shoutout to Max Lukonin](https://github.com/juliuswaldmann/parallax-react/blob/main/README.md#shoutout-to-max-lukonin)
-2. [Installation](https://github.com/juliuswaldmann/parallax-react/blob/main/README.md#installation)
-   * [Using npm](https://github.com/juliuswaldmann/parallax-react/blob/main/README.md#using-npm)
-   * [Manual Installation](https://github.com/juliuswaldmann/parallax-react/blob/main/README.md#manual-installation)
-3. [Usage](https://github.com/juliuswaldmann/parallax-react/blob/main/README.md#usage)
-   * [Import](https://github.com/juliuswaldmann/parallax-react/blob/main/README.md#import)
-   * [Creating a Parallax effect](https://github.com/juliuswaldmann/parallax-react/blob/main/README.md#creating-a-parallax-effect)
-   * [Scroll speed](https://github.com/juliuswaldmann/parallax-react/blob/main/README.md#scroll-speed)
-   * [zIndex](https://github.com/juliuswaldmann/parallax-react/blob/main/README.md#zindex)
-4. [License](https://github.com/juliuswaldmann/parallax-react/blob/main/README.md#license)
+1. [Introduction](https://github.com/juliuswaldmann/parallax-react-js/blob/main/README.md#introduction)
+   * [Description](https://github.com/juliuswaldmann/parallax-react-js/blob/main/README.md#descriptiom)
+   * [Shoutout to Max Lukonin](https://github.com/juliuswaldmann-js/parallax-react/blob/main/README.md#shoutout-to-max-lukonin)
+2. [Installation](https://github.com/juliuswaldmann/parallax-react-js/blob/main/README.md#installation)
+   * [Using npm](https://github.com/juliuswaldmann/parallax-react-js/blob/main/README.md#using-npm)
+   * [Manual Installation](https://github.com/juliuswaldmann/parallax-react-js/blob/main/README.md#manual-installation)
+3. [Usage](https://github.com/juliuswaldmann/parallax-react-js/blob/main/README.md#usage)
+   * [Import](https://github.com/juliuswaldmann/parallax-react-js/blob/main/README.md#import)
+   * [Creating a Parallax effect](https://github.com/juliuswaldmann/parallax-react-js/blob/main/README.md#creating-a-parallax-effect)
+   * [Scroll speed](https://github.com/juliuswaldmann/parallax-react-js/blob/main/README.md#scroll-speed)
+   * [zIndex](https://github.com/juliuswaldmann/parallax-react-js/blob/main/README.md#zindex)
+4. [License](https://github.com/juliuswaldmann/parallax-react-js/blob/main/README.md#license)
 
@@ -38,7 +38,8 @@ ## Introduction
 
-1. clone the repository with `git clone https://github.com/juliuswaldmann/parallax-react.git`
-2. open a terminal inside of the repository folder
+1. clone the repository with `git clone https://github.com/juliuswaldmann/parallax-react-js.git`
+2. open a terminal inside of the repository folder.
 3. compile the package with `npx tsc -p tsconfig.json`
-4. go to the project folder you want to install the package to and open a terminal
-5. run `npm install CLONED_REPOSITORY_FOLDER` where `CLONED_REPOSITORY_FOLDER` is the path to the repository you just cloned.
+4. run `npm pack` to create a .tgz file of the package (npm link DOES NOT work. You have to pack!).
+5. go to the project folder you want to install the package to and open a terminal.
+6. run `npm install TARBALL` where `TARBALL` is the path to the .tgz file `npm pack` created.
 
@@ -45,0 +46,0 @@ ## Usage

No alert changes

Improved metrics

Total package byte prevSize

14063

increased by0.78%

Number of lines in readme file

124

increased by0.81%

No dependency changes