Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 68 lines (40 sloc) 3.912 kb
31cbaf2 @dimsemenov readme up (Travis build status)
authored
1 # PhotoSwipe Repository
2
0854fd3 @dimsemenov README badges
authored
3 [![Build Status](https://travis-ci.org/dimsemenov/PhotoSwipe.svg)](https://travis-ci.org/dimsemenov/PhotoSwipe)
4 [![devDependency Status](https://david-dm.org/dimsemenov/PhotoSwipe/dev-status.svg)](https://david-dm.org/dimsemenov/PhotoSwipe#info=devDependencies)
a003c37 @dimsemenov readme upd (badges)
authored
5 [![Donate](https://img.shields.io/gratipay/dimsemenov.svg?style=flat)](https://gratipay.com/dimsemenov/)
6 [![Flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/3698358/dimsemenovPhotoSwipe-on-GitHub)
0854fd3 @dimsemenov README badges
authored
7
7e8f94a @dimsemenov Initial (new version, 4.0)
authored
8 JavaScript image gallery for mobile and desktop.
597283e @codecomputerlove Update README.md
codecomputerlove authored
9
b0271b1 @amiraliakbari Fixed link to documentation
amiraliakbari authored
10 - [Documentation and getting started guide](http://photoswipe.com/documentation/getting-started.html).
aaf3fa5 @dimsemenov readme upd
authored
11 - [Demo and script home page](http://photoswipe.com).
0a32e91 @dimsemenov readme upd
authored
12 - [NPM](https://www.npmjs.com/package/photoswipe) `npm install photoswipe`.
13 - Bower `bower install photoswipe`.
aaf3fa5 @dimsemenov readme upd
authored
14
c36e14a @d10 Update README.md
d10 authored
15 ## Location of files
1d6cfea Update to README.md
Ste Brennan authored
16
0a32e91 @dimsemenov readme upd
authored
17 - Compiled PhotoSwipe JS and CSS files, SVG and PNG sprites are in the [dist/](https://github.com/dimsemenov/PhotoSwipe/tree/master/dist) folder.
18 - Source files (.JS and .SCSS) are in the [src/](https://github.com/dimsemenov/PhotoSwipe/tree/master/src) folder. Note that PhotoSwipe uses Autoprefixer when compiling SASS files.
19 - Demo website is in the [website/](https://github.com/dimsemenov/PhotoSwipe/tree/master/website) folder.
20 - Documentation markdown files are in [website/documentation/](https://github.com/dimsemenov/PhotoSwipe/tree/master/website/documentation).
494ec0f Initial commit
Code Computerlove authored
21
4a9ccbd @dimsemenov readme upd
authored
22 ## Plugins / extensions / addons
74bc1b8 @dimsemenov readme upd
authored
23
0a32e91 @dimsemenov readme upd
authored
24 - [Ruby gem](https://rubygems.org/gems/photoswipe-rails).
25 - [Ember.js addon](https://github.com/poetic/ember-cli-photoswipe).
e3c82d8 @dimsemenov Update README.md
authored
26 - [Eager app](https://eager.io/app/DvuKIoU8iTOt).
fe6a65b @dimsemenov readme upd
authored
27 - [Koken CMS plugin](https://github.com/DanielMuller/koken-plugin-photoswipe).
9f6239f @dimsemenov readme upd
authored
28
4a9ccbd @dimsemenov readme upd
authored
29 Coded something useful? <a href='mailto:diiiimaaaa@gmail.com?subject="PhotoSwipe Plugin"'>Email me</a> and I’ll post a link to it here.
494ec0f Initial commit
Code Computerlove authored
30
7e8f94a @dimsemenov Initial (new version, 4.0)
authored
31 ## Build
494ec0f Initial commit
Code Computerlove authored
32
0a32e91 @dimsemenov readme upd
authored
33 To compile PhotoSwipe by yourself, make sure that you have [Node.js](http://nodejs.org/), [Grunt.js](https://github.com/cowboy/grunt), [Ruby](http://www.ruby-lang.org/) and [Jekyll](https://github.com/mojombo/jekyll/) installed, then:
494ec0f Initial commit
Code Computerlove authored
34
c36e14a @d10 Update README.md
d10 authored
35 1) Clone the repository
c548309 v1.0.11
codecomputerlove authored
36
7e8f94a @dimsemenov Initial (new version, 4.0)
authored
37 git clone https://github.com/dimsemenov/PhotoSwipe.git
4ab9893 Updated README.md to include in v2 beta details
codecomputerlove authored
38
c36e14a @d10 Update README.md
d10 authored
39 2) Go inside the PhotoSwipe folder that you fetched and install Node dependencies
8ff7b87 v2.1.3
Ste Brennan authored
40
7e8f94a @dimsemenov Initial (new version, 4.0)
authored
41 cd PhotoSwipe && npm install
8ff7b87 v2.1.3
Ste Brennan authored
42
0a32e91 @dimsemenov readme upd
authored
43 3) Run `grunt` to generate the JS and CSS files in the `dist` folder and the site in the `_site/` folder
8ff7b87 v2.1.3
Ste Brennan authored
44
7e8f94a @dimsemenov Initial (new version, 4.0)
authored
45 grunt
8ff7b87 v2.1.3
Ste Brennan authored
46
7e8f94a @dimsemenov Initial (new version, 4.0)
authored
47 Optionally:
923c084 v2.0.1
codecomputerlove authored
48
0a32e91 @dimsemenov readme upd
authored
49 - Run `grunt watch` to automatically rebuild files (JS, CSS, demo website and documentation) when you change files in `src/` or in `website/`.
50 - Run `grunt nosite` to build just JS and CSS files (output is folder `dist/`).
aaf3fa5 @dimsemenov readme upd
authored
51 - Run `grunt pswpbuild` to build just JS files. Param `--pswp-exclude` allows to exclude modules, for example `grunt pswpbuild --pswp-exclude=history` will exclude history module.
28617a4 v3.0.1
Ste Brennan authored
52
7e8f94a @dimsemenov Initial (new version, 4.0)
authored
53 ## Using PhotoSwipe?
923c084 v2.0.1
codecomputerlove authored
54
c36e14a @d10 Update README.md
d10 authored
55 If you’ve used PhotoSwipe in some interesting way, or on the site of a popular brand, I’d be very grateful if you <a href='mailto:diiiimaaaa@gmail.com?subject="Site that uses PhotoSwipe"'>shoot me</a> a link to it.
2ca1f1d v2.1.6
Ste Brennan authored
56
7e8f94a @dimsemenov Initial (new version, 4.0)
authored
57 ## License
2ca1f1d v2.1.6
Ste Brennan authored
58
7e8f94a @dimsemenov Initial (new version, 4.0)
authored
59 Script is licensed under MIT license with one exception: Do not create a public WordPress plugin based on it, as I will develop it. If you need to use it for a public WordPress plugin right now, please ask me by email first. Thanks!
6133e65 v3.0.0
Ste Brennan authored
60
c36e14a @d10 Update README.md
d10 authored
61 Attribution is not required, but much appreciated, especially if you’re making a product for developers.
34be394 v2.1.4
codecomputerlove authored
62
7e8f94a @dimsemenov Initial (new version, 4.0)
authored
63 ## About
34be394 v2.1.4
codecomputerlove authored
64
aaf3fa5 @dimsemenov readme upd
authored
65 PhotoSwipe 4.0+ is developed by [Dmitry Semenov](http://twitter.com/dimsemenov). But initially script was created in 2011 by [Code Computerlove](http://www.codecomputerlove.com/), a digital agency in Manchester, they [passed](https://twitter.com/PhotoSwipe/status/444134042787930113) on development in March 2014. You can view [source and documentation](https://github.com/dimsemenov/PhotoSwipe/tree/v3.0.3) of old PhotoSwipe (<4.0) in history of this repo.
66
67
Something went wrong with that request. Please try again.