diff --git a/README.md b/README.md index 393f7d8..7d02c67 100644 --- a/README.md +++ b/README.md @@ -17,22 +17,22 @@ React Component to lazy load images using a HOC to track window scroll position. ## Installation -1. Install react-lazy-load-image as a dependency: +1. Install react-lazy-load-image-component as a dependency: ```bash # Yarn -$ yarn add react-lazy-load-image +$ yarn add react-lazy-load-image-component # NPM -$ npm i --save react-lazy-load-image +$ npm i --save react-lazy-load-image-component ``` 2. Import the LazyLoadImage component: ```javascript -import { LazyLoadImage } from 'react-lazy-load-image' +import { LazyLoadImage } from 'react-lazy-load-image-component' ``` 3. Import the trackWindowScroll HOC: ```javascript -import { trackWindowScroll } from 'react-lazy-load-image' +import { trackWindowScroll } from 'react-lazy-load-image-component' ``` @@ -40,7 +40,8 @@ import { trackWindowScroll } from 'react-lazy-load-image' ```javascript import React from 'react'; -import { LazyLoadImage, trackWindowScroll } from 'react-lazy-load-image'; +import { LazyLoadImage, trackWindowScroll } + from 'react-lazy-load-image-component'; const Gallery = ({ images, scrollPosition }) => (
@@ -48,14 +49,14 @@ const Gallery = ({ images, scrollPosition }) => ( attributes as props width={image.width} /> )}
); -// Wrap Gallery with trackWindowScroll HOC so it receives a scrollPosition prop -// to pass down to the images +// Wrap Gallery with trackWindowScroll HOC so it receives +// a scrollPosition prop to pass down to the images export default trackWindowScroll(Gallery); ``` @@ -73,4 +74,4 @@ export default trackWindowScroll(Gallery); ## Screenshots - + diff --git a/package.json b/package.json index 1389b45..767072b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "react-lazy-load-image", - "version": "0.0.1", + "name": "react-lazy-load-image-component", + "version": "1.0.0", "description": " React Component to lazy load images using a HOC to track window scroll position. ", "main": "build/index.js", "peerDependencies": { @@ -32,7 +32,7 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/Aljullu/react-lazy-load-image.git" + "url": "git+https://github.com/Aljullu/react-lazy-load-image-component.git" }, "keywords": [ "react", @@ -44,7 +44,7 @@ }, "license": "MIT", "bugs": { - "url": "https://github.com/Aljullu/react-lazy-load-image/issues" + "url": "https://github.com/Aljullu/react-lazy-load-image-component/issues" }, - "homepage": "https://github.com/Aljullu/react-lazy-load-image#readme" + "homepage": "https://github.com/Aljullu/react-lazy-load-image-component#readme" }