Skip to content
This repository was archived by the owner on Jan 19, 2023. It is now read-only.

Commit 40a8af8

Browse files
committed
Update website and readme
1 parent 5f80a95 commit 40a8af8

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,27 @@ imageTitle | string | | | Image title
9595
toolbarButtons | node[] | | | Array of custom toolbar buttons
9696
imagePadding | number | `10` | | Padding (px) between the edge of the window and the lightbox
9797
clickOutsideToClose | bool | `true` | | When true, clicks outside of the image close the lightbox
98+
99+
## Contributing
100+
101+
After cloning the repository and running `npm install` inside, you can use the following commands to develop and build the project.
102+
103+
```sh
104+
# Starts a webpack dev server that hosts a demo page with the lightbox.
105+
# It uses react-hot-loader so changes are reflected on save.
106+
npm start
107+
108+
# Lints the code with eslint and my custom rules.
109+
npm run lint
110+
111+
# Lints and builds the code, placing the result in the dist directory.
112+
# This build is necessary to reflect changes if you're
113+
# `npm link`-ed to this repository from another local project.
114+
npm run build
115+
```
116+
117+
Pull requests are welcome!
118+
119+
## License
120+
121+
MIT

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"type": "git",
2424
"url": "https://github.com/fritz-c/react-image-lightbox.git"
2525
},
26-
"homepage": "https://github.com/fritz-c/react-image-lightbox",
26+
"homepage": "https://fritz-c.github.io/react-image-lightbox",
2727
"bugs": "https://github.com/fritz-c/react-image-lightbox/issues",
2828
"authors": [
2929
"Chris Fritz"

0 commit comments

Comments
 (0)