|
@@ -1,3 +1,52 @@
|
|
|
-# Splide v3
|
|
|
+<div align="center">
|
|
|
+<a href="https://splidejs.com">
|
|
|
+ <img alt="Splide" src="./images/logo.svg" width="70">
|
|
|
+</a>
|
|
|
|
|
|
-WIP
|
|
|
+<h1>Splide</h1>
|
|
|
+
|
|
|
+<p>
|
|
|
+Splide is a lightweight, flexible and accessible slider and carousel. written in TypeScript.
|
|
|
+No dependencies, no Lighthouse errors.
|
|
|
+</p>
|
|
|
+
|
|
|
+<p>
|
|
|
+ <a href="https://splidejs.com/guides/getting-started/">Getting Started</a>
|
|
|
+ <br>
|
|
|
+ <a href="https://splidejs.com/">Demo</a>
|
|
|
+ <br>
|
|
|
+ <a href="https://splidejs.com/documents/">Documents</a>
|
|
|
+ <br>
|
|
|
+ <a href="https://splidejs.com/guides/themes/">Themes</a>
|
|
|
+ <br>
|
|
|
+ <a href="https://splidejs.com/guides/version3/">About v3</a>
|
|
|
+</p>
|
|
|
+</div>
|
|
|
+
|
|
|
+## Features
|
|
|
+
|
|
|
+- Written in TypeScript
|
|
|
+- No dependencies
|
|
|
+- Lightweight, less than 26kB (11kB gzipped)
|
|
|
+- Flexible and extensible
|
|
|
+- Protected by 300+ test cases
|
|
|
+- Multiple slides
|
|
|
+- Slide or fade transition by CSS
|
|
|
+- Supports breakpoints
|
|
|
+- Accepts CSS relative units
|
|
|
+- No need to crop images
|
|
|
+- Autoplay with progress bar and play/pause buttons
|
|
|
+- RTL and vertical direction
|
|
|
+- Mouse drag and touch swipe
|
|
|
+- Free drag mode
|
|
|
+- Mouse wheel navigation
|
|
|
+- Nested slider
|
|
|
+- Lazy loading
|
|
|
+- Thumbnail slider
|
|
|
+- Auto width and height
|
|
|
+- Accessibility friendly
|
|
|
+- Internet Explorer 10
|
|
|
+
|
|
|
+## License
|
|
|
+
|
|
|
+Splide is released under MIT license. © 2021 Naotoshi Fujita
|