Readme added

flyerhq · Feb 12, 2021 · 05b4696 · 05b4696
1 parent e68c40c
commit 05b4696
Show file tree

Hide file tree

Showing 6 changed files with 68 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.0.9
+
+- Readme added
+
 ## 0.0.8
 
 - Dependency update

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Oleksandr Demchenko
+Copyright (c) 2021 Oleksandr Demchenko
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1 +1,62 @@
 # Flutter Link Preview
+
+URL preview with basic customization and ability to render from cached data
+
+![Demo](images/flutter_link_previewer.png)
+
+## Getting Started
+
+```dart
+LinkPreview(
+  onPreviewDataFetched: _onPreviewDataFetched,
+  text: 'instagram.com',
+  width: MediaQuery.of(context).size.width,
+)
+```
+
+## Customization
+
+```dart
+final style = TextStyle(
+  color: Colors.red,
+  fontSize: 16,
+  fontWeight: FontWeight.w500,
+  height: 1.375,
+);
+
+
+LinkPreview(
+  linkStyle: style,
+  metadataTextStyle: style.copyWith(
+    fontSize: 14,
+    fontWeight: FontWeight.w400,
+  ),
+  metadataTitleStyle: style.copyWith(
+    fontWeight: FontWeight.w800,
+  ),
+  padding: EdgeInsets.symmetric(
+    horizontal: 24,
+    vertical: 16,
+  ),
+  onPreviewDataFetched: _onPreviewDataFetched,
+  text: "Your text with link here",
+  textStyle: style,
+  width: width,
+);
+```
+
+## Render from cached data
+
+Store data you get in `onPreviewDataFetched` callback, then
+
+```dart
+LinkPreview(
+  previewData: _cachedData,
+  text: 'instagram.com',
+  width: MediaQuery.of(context).size.width,
+)
+```
+
+## License
+
+[MIT](LICENSE)
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -73,7 +73,7 @@ class HomePage extends StatelessWidget {
                 text: 'instagram.com',
                 width: MediaQuery.of(context).size.width,
               ),
-            )
+            ),
           ],
         ),
       ),

diff --git a/lib/src/images/flutter_link_previewer.png b/lib/src/images/flutter_link_previewer.png
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: flutter_link_previewer
 description: Flutter Link Previewer
-version: 0.0.8
+version: 0.0.9
 homepage: https://github.com/flyerhq/flutter_link_previewer
 
 environment:
-Original file line number
+Diff line change
@@ Expand Up / @@ -73,7 +73,7 @@ class HomePage extends StatelessWidget { @@
                     text: 'instagram.com',
                     width: MediaQuery.of(context).size.width,
                   ),
-                )
+                ),
               ],
             ),
           ),
@@ Expand Down @@