Add getting started direction in README

jerrylow · Jan 30, 2021 · d125c84 · d125c84
1 parent 1a21510
commit d125c84
Showing 1 changed file with 31 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -16,6 +16,37 @@ The jQuery version remains the same as 1.0.0. While the source remains unchanged
 
 These changes should have no impact on the way it functions in comparison with 1.x.
 
+## Getting Started
+
+### jQuery
+
+Include the jQuery library in the `<head>` of your page.
+
+```
+<script src="jquery.min.js"></script>
+<script type="text/javascript" src="jquery.basictable.min.js"></script>
+```
+
+Initiate on any table(s) with:
+
+```
+$('table').basictable();
+```
+
+### Vanilla JS
+
+Include the basictable library in the `<head>` of your page.
+
+```
+<script type="text/javascript" src="basictable.min.js"></script>
+```
+
+Initiate on any table(s) with:
+
+```
+new basictable('table');
+```
+
 ## Options
 
 Options are applicable to both the jQuery and Vanilla JS.