Update and rename README.textile to README.md

stephband · Dec 20, 2023 · 9f89421 · 9f89421
1 parent 8a36df1
commit 9f89421
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+> [!WARNING]  
+> This plugin is unsupported. Note that it has been possible to make parallax effects in near-pure CSS for some time, using a combination of `translateZ()`, `perspective`, and either a bit of JS for pointer tracking or a scrolling container. It is srongly suggested that you explore that avenue, as the resulting animations are optimised for the GPU, and smoother than this plugin can ever be. There is parallax scrolling page that I made based on this technique [here](https://decouverte-metiers.epfl.ch/fr/s/quartier-1/)
+
+
+# jquery.parallax
+
+## What does jquery.parallax do?
+
+jquery.parallax turns nodes into absolutely positioned layers that move in response to the mouse. Depending on their dimensions, and on the options passed in, these layers move at different rates, in a parallaxy kind of way.
+
+## Demos and docs
+
+<a href="http://stephen.band/jparallax/">stephen.band/jparallax/</a>
diff --git a/README.textile b/README.textile