init

zyra · Mar 18, 2017 · 59b6c8b · 59b6c8b
1 parent 9a7e4a6
commit 59b6c8b
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/README.md 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>
+```