1Scatter
2
3* Version: 0.1.1
4* License: LGPLv3
5* Homepage: https://www.sorcerersisle.com/software/scatter
6* Documentation: https://docs.sorcerersisle.com/scatter
7* Repository: https://code.sorcerersisle.com/scatter.git
8* Issues: https://github.com/boughtonp/scatter/issues
9
10
11Description
12-----------
13
14Scatter is a JavaScript library for randomly arranging HTML elements within a
15containing element.
16
17The main use case is an image gallery, but the library does not restrict what
18it can be used for - it can provide a scattered polaroid photo effect as easily
19as using decorative images to provide a randomized background, or any other
20reasons for scattering items your imagination can come up with.
21
22The demos directory provides various examples showing how to achieve different
23effects. For further detail on how Scatter works, check the docs.pdf file.
24
25
26Requirements
27------------
28
29Scatter is designed to work in any modern browser, without any dependencies.
30
31Older browsers (released before 2015) can be supported with polyfills for
32Object.assign and Array.from - adding these allows Scatter to work with
33Internet Explorer 11.0.9600, and possibly Firefox 3.6
34
35With a polyfill for Element.classList it may work as far back as IE9, but this
36has not been tested, and is not specifically supported.
37
38
39Licensing & Credits
40-------------------
41
42This project is available under the terms of the LGPLv3 license.
43See license.txt to understand your rights and obligations.
44
45Scatter was created by Peter Boughton.
46
47
48Contributing
49------------
50
51This project aims to adhere to the philosophy "do one thing well", and also to
52keep the core script simple and understandable.
53
54Fixes, simplifications, and improvements to existing functionality are welcome.
55Additional features or larger changes are not a priority.
56
57If in doubt, raise an issue to discuss first.
58
59
60/eof
