docs(README): add initial README

AbsharHassan · Jan 12, 2024 · 96045d5 · 96045d5
1 parent 19f20af
commit 96045d5
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,15 @@
+<div align="center">
+  <h1 align="center">
+    react-r3f-shader-hook
+  </h1>
+  <p>
+    A React (R3F) hook to apply a shader to the entire scene without having to <code>EffectComposer<code>
+  </p>
+  <!-- <p>
+    <a href="https://www.npmjs.com/package/react-localstorage-hooks">
+      <img src="https://badgen.net/npm/v/react-localstorage-hooks" />
+    </a>
+    <img src="https://badgen.net/npm/types/react-localstorage-hooks" />
+  </p> -->
+  <br />
+</div>