From 59b6c8ba281e73663ea617bc9f33979098c4d5cb Mon Sep 17 00:00:00 2001
From: Ibby <ibby93@gmail.com>
Date: Fri, 17 Mar 2017 22:22:48 -0400
Subject: [PATCH] init

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bc8715f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+Swipeable tabs for Ionic 2.
+
+Work in progress, but essentially works.
+
+```
+npm i --save ionic2-super-tabs
+```
+
+```
+import { SuperTabsModule } from 'ionic2-super-tabs';
+
+@NgModule({
+    ...
+    imports: [
+      ...
+      SuperTabsModule
+      ],
+    ...
+})
+```
+
+```
+<super-tabs>
+  <super-tab [tabRoot]="page1" title="First page" [icon]="'home'"></super-tab>
+  <super-tab [tabRoot]="page2" title="Second page" [icon]="'pin'"></super-tab>
+  <super-tab [tabRoot]="page3" title="Third page" [icon]="'heart'"></super-tab>
+</super-tabs>
+```
\ No newline at end of file