Skip to content

Commit 91c5dc2

Browse files
committed
Update README.md
1 parent 39ee638 commit 91c5dc2

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
[![npm version](https://badge.fury.io/js/@hueyyeng%2Fsimple-react-lightbox.svg)](https://badge.fury.io/js/@hueyyeng%2Fsimple-react-lightbox)
44

5-
A demo that uses the latest version of this library can be found on my personal website: [https://taukeke.com/gallery](https://taukeke.com/gallery)
5+
> A demo that uses the latest version of this library can be found on my personal website: [https://taukeke.com/gallery](https://taukeke.com/gallery)
66
77
Modified React lightbox based on Michele Cocuccio's Simple React Lightbox. The original README.md can be found here: [README.old.md](README.old.md).
88

9-
As the original GitHub repository no longer exists/accessible, I made some minor tweaking to suit my requirements hence the
10-
forking (although I originally forked it from a forked repo of the original repository).
9+
Since the original GitHub repository is no longer accessible, I had to make some custom modifications to align with my specific
10+
needs. As a result, I ended up forking the project from a repository that was itself a fork of the original repository.
1111

12-
Also the code has been converted to **TypeScript** (using TypeScript 5.0).
12+
The code has also been converted to TypeScript, using TypeScript 5.0.
1313

1414
## Changes Since v3.6.9 by Michele Cocuccio
1515

@@ -22,14 +22,18 @@ Also the code has been converted to **TypeScript** (using TypeScript 5.0).
2222

2323
## Quickstart
2424

25-
The following steps should suffice to get it up and running in your React app.
25+
To get started with this library in your React app, follow these steps:
2626

27-
Currently this is only tested with React 17. Likely to work with no issue for React 16 but not guaranteed
28-
with React 18. Feel free to open a pull request if you made it compatible with React 18!
27+
1. Make sure you have **React** installed. Although the library has been tested with React 17 and
28+
is expected to work with React 16, compatibility with React 18 is not guaranteed. If you have made
29+
it compatible with React 18, please feel free to open a pull request.
30+
2. Ensure you have **Node.js 16** installed.
31+
3. Use **Yarn** as your package manager, as it is required for this library.
2932

30-
Lastly, I tested this with **Node 16**. Also requires **yarn**!
33+
### Installing as Local Package
3134

32-
1. Clone this repository with `git clone yourpreferredmethod.git @hueyyeng/simple-react-lightbox` using either SSH or HTTPS. The resulting folder should look like this (e.g. yourreactapp/packages/@hueyyeng/simple-react-lightbox).
35+
1. Clone this repository with `git clone yourpreferredmethod.git @hueyyeng/simple-react-lightbox` using
36+
either SSH or HTTPS. The resulting folder should look like this (e.g. yourreactapp/packages/@hueyyeng/simple-react-lightbox).
3337
2. Optionally, exclude it using React app `.gitignore`.
3438
3. Add this to your React app `package.json` dependencies (using step 1 example path).
3539

@@ -49,7 +53,7 @@ to automatically reload with the new changes.
4953

5054
## Usage
5155

52-
> Make sure at least **Node 16** and **yarn** installed.
56+
> Make sure at least **Node.js 16** and **Yarn** installed.
5357
5458
### Development
5559

@@ -65,4 +69,6 @@ to automatically reload with the new changes.
6569

6670
## Known Issues
6771

68-
1, Several forked of this project modified the React version range to include React 16. As this library uses React Context introduced in React 16.3, try to target that version as the absolute minimum version.
72+
1. Several forks of this project have adjusted the React version range to include React 16. However,
73+
since this library relies on React Context, which was introduced in React 16.3, it is recommended
74+
to set React 16.3 as the minimum required version.

0 commit comments

Comments
 (0)