Skip to content

Commit 6e04e47

Browse files
committed
Update package.json. +readme cleaning
1 parent 3c792b4 commit 6e04e47

File tree

2 files changed

+62
-144
lines changed

2 files changed

+62
-144
lines changed

README.md

Lines changed: 6 additions & 144 deletions
Original file line numberDiff line numberDiff line change
@@ -4,155 +4,17 @@ The original lightbox script. Eight years later — still going strong!
44

55
Lightbox is small javascript library used to overlay images on top of the current page. It's a snap to setup and works on all modern browsers.
66

7-
For demos and usage instructions, visit [lokeshdhakar.com/projects/lightbox2/](http://lokeshdhakar.com/projects/lightbox2/).
7+
- [Demos and usage instructions](http://lokeshdhakar.com/projects/lightbox2/)
8+
- [Releases and changelog](https://github.com/lokesh/lightbox2/releases)
9+
- [Roadmap](https://raw.githubusercontent.com/lokesh/lightbox2/master/ROADMAP.md)
10+
- [License](https://raw.githubusercontent.com/lokesh/lightbox2/master/LICENSE)
811

912
by [Lokesh Dhakar](http://www.lokeshdhakar.com)
1013

1114

12-
## Roadmap
15+
## How to make a release and deploy
1316

14-
### Actively being worked on
15-
16-
- **Maintenance.** Geting open Issues and PRs number down. Not working on new features for v2.x.
17-
18-
### Features *NOT* on the roadmap
19-
20-
The goal of this script from it's beginnings till today is to to provide a better *image viewing experience*.
21-
22-
- **HTML or video content.** If you need to show html or video content, I recommend googling for an alternative script as there are many options.
23-
- **Social sharing buttons.**
24-
25-
### v3.0 - In Brainstorming Phase
26-
27-
**Interactions**
28-
- Add touch gesture support.
29-
- Exploring using tilt gesture on mobile devices with extra-wide images.
30-
- If user attempts to go forward when at end of image set, animation (shake?) indicating the end or option to close Lightbox.
31-
- Make sure right-click/long pressing works to access the image's context menu.
32-
33-
**Layout**
34-
- Allow vertical centering.
35-
- Update sizing on window resize.
36-
- Should the dev be able to choose the position of the caption, close button, and nav controls?
37-
- Optimize layout for mobile.
38-
- Optimize layout for screens of varying densities.
39-
- Should the close button still live in the bottom right corner?
40-
41-
**Animations**
42-
- Evaluate start, end, and transition animations.
43-
- Rewrite animations for performance and flexibility.
44-
45-
**Assets**
46-
- Use inline SVG for UI elements.
47-
48-
**Caching**
49-
- Review if and how images should be preloaded
50-
51-
**Accessibility**
52-
- Should opening lightbox update the url? and should this url be parsed on page load to show Lightbox automatically?
53-
- Review alt attributes.
54-
- Review ARIA roles.
55-
- Review constrast ratios.
56-
- Review keyboard input and tabbing.
57-
- Review click/touch target size.
58-
- Test with screen reader.
59-
60-
**API**
61-
- Do not initialize automatically and allow multiple instances.
62-
- Add event handlers.
63-
- Allow setting options on the fly.
64-
- Allow the setting of options from HTML?
65-
- Allow instantiation with jQuery plugin syntax.
66-
- Evaluate preloading and caching.
67-
- Evaluate droppping jQuery requirement.
68-
- Allow placement inside of a specified element? Orig feature requester was dealing with iframe.
69-
70-
## Changelog
71-
72-
### v2.9.0 - 2016-10-30
73-
74-
- [Fix] Allow loading of lightbox.js anywhere on page. Prev requirement was at the end of the body tag. [Commit](https://github.com/lokesh/lightbox2/commit/7047214f77cfc8f892e8513426b57d45bf29e9cd)
75-
- [Add] Add imageFadeDuration option. [Commit](https://github.com/lokesh/lightbox2/commit/6d5f99a65f189a5d2bd7bbfac4682fe36e62871e)
76-
- [Change] Right-clicking image now shows context menu for image. [Commit](https://github.com/lokesh/lightbox2/commit/363c3cb8af8fae1b6f95d6679df976022290f878)
77-
- [Change] Allow controlling of image border with a simpler css border vs a parent container padding _hack_. [Commit](https://github.com/lokesh/lightbox2/commit/214361297f1dd5f0c19c1d80ff37c398cdda55cb)
78-
79-
### v2.8.2 - 2015-12-13
80-
81-
- [Add] npm support. ```npm install --save lightbox2```
82-
- [Add] Add option to disable vertical scrolling [#487](https://github.com/lokesh/lightbox2/pull/487) Thanks [blacksunshineCoding](https://github.com/blacksunshineCoding)
83-
- [Fix] When horizontal scrolling is on page the overlay is not covering entire page [#485](https://github.com/lokesh/lightbox2/pull/485) Thanks [@manuel-io](https://github.com/manuel-io)
84-
- [Change] Add css minify task to Gruntfile.js and removedlegacy css vendor prefixes for border-radius. [#470](https://github.com/lokesh/lightbox2/pull/470) Thanks [ajerez](https://github.com/ajerez)
85-
86-
87-
### v2.8.1 - 2015-07-09
88-
89-
- [Fix] Change AMD jQuery require statement to use all lowercase. [#464](https://github.com/lokesh/lightbox2/pull/464) Thanks [@vtforester](https://github.com/vtforester)
90-
91-
### v2.8.0 - 2015-06-29
92-
93-
- [Add] UMD support (AMD, CommonJS, fallback to global export).[#461](https://github.com/lokesh/lightbox2/pull/461)
94-
- [Add] option method for setting options. [#461](https://github.com/lokesh/lightbox2/commit/d708fbd716aaa90e01ba4198944c8955e7283d87)
95-
- [Add] CONTRIBUTING.md
96-
97-
### v2.7.4 - 2015-06-23
98-
99-
- [Change] Revert jquery dep version to 2.x from 1.x. Added note to Lightbox page about using jQuery 1.x to get IE6, 7, and 8 support.
100-
- [Fix] Preserve author and license comments from lightbox.js in minified files.
101-
102-
### v2.7.3 - 2015-06-22
103-
104-
- [Add] Barebone HTML file with examples /examples/index.html.
105-
- [Add] jquery.lightbox.js which concatenates jQuery and Lightbox. This is for those who are Bower averse or want an extra easy install.
106-
107-
### v2.7.2 - 2015-06-16
108-
109-
- [Add] maxWidth and maxHeight options added [#197](https://github.com/lokesh/lightbox2/pull/197)
110-
- [Add] Enable target attribute in caption links [#299](https://github.com/lokesh/lightbox2/pull/299)
111-
- [Change] Switched to The MIT License from Creative Commons Attribution 4.0 International License.
112-
- [Change] Add CSS and images to bower.json main property.
113-
- [Change] Dropped version property from bower.json. [#453](https://github.com/lokesh/lightbox2/pull/453)
114-
- [Change] Use src -> dist folder structure for build.
115-
- [Fix] Remove empty src attribute from img tag [#287](https://github.com/lokesh/lightbox2/pull/287)
116-
- [Fix] Correct grammatical error in comment [#224](https://github.com/lokesh/lightbox2/pull/224)
117-
- [Fix] Clear the jquery animation queue before hiding the .lb-loader [#309](https://github.com/lokesh/lightbox2/pull/309)
118-
- [Remove] Remove releases's zips from repo.
119-
120-
### v2.7.1 - 2014-03-30
121-
122-
- [Fix] Enable links in captions
123-
124-
### v2.7.0 - 2014-03-29
125-
126-
- [Add] Support for data-title attribute for the caption. - Thanks [@copycut](https://github.com/copycut)
127-
- [Add] New option to enable always visible prev and next arrows
128-
- [Change] Rewrite Coffeescript code into plain ole Javascript
129-
- [Change] Updated jQuery to v1.10.2
130-
- [Fix] prev/next arrows not appearing in IE9 and IE 10 - Thanks [@rebizu](https://github.com/rebizu)
131-
- [Fix] Support wrap around option w/keyboard actions. Thanks [@vovayatsyuk](https://github.com/vovayatsyuk)
132-
133-
### v2.6.0 - 2013-07-06
134-
135-
- [Add] Added wraparound option
136-
- [Add] Added fitImagesInViewport option - now mobile friendly
137-
- [Add] Added showImageNumber label
138-
- [Add] Compatibility with html5shiv
139-
- [Add] Html5 valid using new data-lightbox attribute
140-
- [Add] Compatibility with hmtl5shiv and modernizr
141-
- [Add] Support jquery 1.9+
142-
- [Change] Move reference to loading and close images into css
143-
- [Change] Cache jquery objects
144-
145-
### v2.5.0 - 2012-04-11
146-
147-
- [Change] Switch to jQuery from Prototype and Scriptaculous
148-
- [Change] Switch from Javacript to Coffeescript
149-
- [Change] Switch from CSS to SASS
150-
- [Add] Repo created on Github
151-
152-
153-
## How to deploy
154-
155-
- Update version number in ```src/lightbox.js```
17+
- Update version number in `src/lightbox.js` and `package.json`
15618
- Update README.md Changelog with release date
15719
- grunt build
15820
- Push to Github repo

ROADMAP.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Roadmap
2+
3+
## v2.x - Maintenance Mode
4+
5+
No new features are being worked on for v2.x.
6+
7+
## v3.0 - In Brainstorming Phase
8+
9+
**Not planned for v3.0**
10+
The goal of this script from it's beginnings till today is to to provide a better *image viewing experience*.
11+
12+
- **HTML or video content.** If you need to show html or video content, I recommend googling for an alternative script as there are many options.
13+
- **Social sharing buttons.**
14+
15+
**Interactions**
16+
- Add touch gesture support.
17+
- Exploring using tilt gesture on mobile devices with extra-wide images.
18+
- If user attempts to go forward when at end of image set, animation (shake?) indicating the end or option to close Lightbox.
19+
- Make sure right-click/long pressing works to access the image's context menu.
20+
21+
**Layout**
22+
- Allow vertical centering.
23+
- Update sizing on window resize.
24+
- Should the dev be able to choose the position of the caption, close button, and nav controls?
25+
- Optimize layout for mobile.
26+
- Optimize layout for screens of varying densities.
27+
- Should the close button still live in the bottom right corner?
28+
29+
**Animations**
30+
- Evaluate start, end, and transition animations.
31+
- Rewrite animations for performance and flexibility.
32+
33+
**Assets**
34+
- Use inline SVG for UI elements.
35+
36+
**Caching**
37+
- Review if and how images should be preloaded
38+
39+
**Accessibility**
40+
- Should opening lightbox update the url? and should this url be parsed on page load to show Lightbox automatically?
41+
- Review alt attributes.
42+
- Review ARIA roles.
43+
- Review constrast ratios.
44+
- Review keyboard input and tabbing.
45+
- Review click/touch target size.
46+
- Test with screen reader.
47+
48+
**API**
49+
- Do not initialize automatically and allow multiple instances.
50+
- Add event handlers.
51+
- Allow setting options on the fly.
52+
- Allow the setting of options from HTML?
53+
- Allow instantiation with jQuery plugin syntax.
54+
- Evaluate preloading and caching.
55+
- Evaluate droppping jQuery requirement.
56+
- Allow placement inside of a specified element? Orig feature requester was dealing with iframe.

0 commit comments

Comments
 (0)