Changed API call from SmoothScroll to SmoothScroll.enable()

README.md

@@ -18,10 +18,10 @@ yarn add @grifart/smoothscroll
 import SmoothScroll from '@grifart/smoothscroll';
 
 // use defaults
-SmoothScroll();
+SmoothScroll.enable();
 
 // customize
-SmoothScroll({
+SmoothScroll.enable({
 	scrollOnLoad: false,
 	scrollOnLinkClick: true,
 });

demo.html

@@ -7,7 +7,7 @@
 	<script src="https://cdn.jsdelivr.net/npm/velocity-animate@1.5/velocity.min.js"></script>
 	<script src="dist/index.js" type="text/javascript"></script>
 	<script>
-		SmoothScroll({
+		SmoothScroll.enable({
 			scrollOnLoad: true,
 			scrollOnLinkClick: true,
 		});

src/index.ts

@@ -8,16 +8,22 @@ export interface SmoothScrollOptions {
 	readonly scrollOnLinkClick?: boolean;
 }
 
-function SmoothScroll(options?: SmoothScrollOptions): void
+/**
+ * Wrapped into class for intuitive API use – `SmoothScroll.enable()`
+ */
+class SmoothScroll
 {
-	setupVelocity(Velocity);
+	public static enable(options?: SmoothScrollOptions): void
+	{
+		setupVelocity(Velocity);
 
-	if ( ! (options && options.scrollOnLoad === false)) {
-		initializeOnLoadScroll();
-	}
+		if ( ! (options && options.scrollOnLoad === false)) {
+			initializeOnLoadScroll();
+		}
 
-	if ( ! (options && options.scrollOnLinkClick === false)) {
-		initializeOnLinkClickScroll();
+		if ( ! (options && options.scrollOnLinkClick === false)) {
+			initializeOnLinkClickScroll();
+		}
 	}
 }