started readme

added banner added banner added banner added banner added banner added banner
Idean · Feb 27, 2020 · f378f23 · f378f23
1 parent 8f47a8e
commit f378f23
Showing 1 changed file with 34 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,22 @@
 # flutter_neumorphic
 
-# Showcases
+[![neumorphic_widget](https://fakeimg.pl/800x100/?text=Idean)](https://fakeimg.pl/700x200/?text=Idean)
 
 [![neumorphic_widget](https://fakeimg.pl/400x700/?text=Showcase_1)](https://fakeimg.pl/400x700/?text=Showcase_1)
 [![neumorphic_widget](https://fakeimg.pl/400x700/?text=Showcase_2)](https://fakeimg.pl/400x700/?text=Showcase_2)
 
+# Installation
+
+https://pub.dev/packages/flutter_neumorphic
+
+[![pub package](https://img.shields.io/pub/v/flutter_neumorphic.svg)](
+https://pub.dartlang.org/packages/flutter_neumorphic)
+
+```dart
+dependencies:
+  flutter_neumorphic: ^0.0.1
+```
+
 # Widgets
 
 | Component | Widget |
@@ -36,31 +48,31 @@ Neumorphic(
 )
 ```
 
-## Neumorphic Button
+### Attributes
 
-[![neumorphic_button](https://fakeimg.pl/350x200/?text=Button)](https://fakeimg.pl/350x200/?text=Button)
+| Attributes | Values | Description |
+|-----------------------|---|---|
+| LightSource | TopLeft, BottomRight, etc. / (dx, dy) | TODO |
+| Shape | Concave / Convex / Flat / Emboss | TODO |
+| Depth | -20 <= double <= 20 | TODO |
+| Intensity | 0 <= double <= 1 | TODO |
+| BaseColor | any Color | TODO | 
+| Accent | any Color | TODO | 
+| CurveFactor |  -1 <= double <= 1 | TODO | 
+| BoxShape | Rect, Circle, RoundRect(radius) | TODO | 
 
-```
-NeumorphicButton(
-  onTap: (){
-    //your action
-  }
-  style: NeumorphicStyle(
-    shape: NeumorphicShape.concave,
-    depth: 10,
-    baseColor: Colors.grey
-  ),
-  minDistance: -2, //can go to emboss
-  accent: Colors.blue,
-  shape: NeumorphicBoxShape.circle()
-  child: ...
-)
-```
+### Shapes
+
+| Shape | IMAGE |
+|-------|-------|
+| Flat | [![neumorphic_theme](https://fakeimg.pl/250x200/?text=Flat)](https://fakeimg.pl/350x200/?text=Theme1) |
+| Convex | [![neumorphic_theme](https://fakeimg.pl/250x200/?text=Convex)](https://fakeimg.pl/350x200/?text=Theme1) |
+| Concave | [![neumorphic_theme](https://fakeimg.pl/250x200/?text=Concave)](https://fakeimg.pl/350x200/?text=Theme1) |
+| Emboss | [![neumorphic_theme](https://fakeimg.pl/250x200/?text=Emboss)](https://fakeimg.pl/350x200/?text=Theme1) |
 
 
 ## Neumorphic Theme
 
-## All widgets
 
 [![neumorphic_theme](https://fakeimg.pl/350x200/?text=Theme1)](https://fakeimg.pl/350x200/?text=Theme1)
 [![neumorphic_theme](https://fakeimg.pl/350x200/?text=Theme2)](https://fakeimg.pl/350x200/?text=Theme2)
@@ -78,19 +90,9 @@ NeumorphicThemeProvider(
 )
 ```
 
-//LINK TO ANOTHER README HERE
-
-# Installation
-
-https://pub.dev/packages/flutter_neumorphic
-
-[![pub package](https://img.shields.io/pub/v/flutter_neumorphic.svg)](
-https://pub.dartlang.org/packages/flutter_neumorphic)
+## All widgets
 
-```dart
-dependencies:
-  flutter_neumorphic: ^(last version)
-```
+//LINK TO ANOTHER README HERE
 
 # Contributors