Update README and add security notice

enwi · Jan 15, 2022 · b2070f8 · b2070f8
1 parent b6249f4
commit b2070f8
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+## 1.0.0-dev.3
+
+### Update README and add security notice
+ - Add Discord Server and link to releases to README
+ - Add security notice to example and README
+ - Fix feature description of README
+
 ## 1.0.0-dev.2
 
 ### Fix flutter version

diff --git a/README.md b/README.md
@@ -1,10 +1,15 @@
+[![Discord](https://img.shields.io/discord/781219798931603527.svg?label=enwi&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/YxVyJWX62h)
+[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/enwi/darttindie?label=release)](https://github.com/enwi/darttindie/releases)
+
 # DartTindie
 Dart wrapper for Tindie Order API
 
+> Note: Never publish your Tindie API Key! It is a secret and should remain one!
+
 ## Features
- - Get all orders (last 30)
- - Get all shipped orders (last 30)
- - Get all unshipped orders (last 30)
+ - Get all orders (last 20)
+ - Get all shipped orders (last 20)
+ - Get all unshipped orders (last 20)
 
 ## Getting started
 ```

diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -29,6 +29,7 @@ class MyHomePage extends StatefulWidget {
 
 class _MyHomePageState extends State<MyHomePage> {
   final tindie = Tindie(
+    // Note: Never publish your Tindie API Key! It is a secret and should remain one!
     apikey: 'enter your api key',
     username: 'enter your username',
   );
@@ -43,7 +44,6 @@ class _MyHomePageState extends State<MyHomePage> {
         title: const Text('Tindie Order Demo'),
       ),
       body: Column(
-        // mainAxisAlignment: MainAxisAlignment.center,
         crossAxisAlignment: CrossAxisAlignment.start,
         children: <Widget>[
           Row(

diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -49,7 +49,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.0.0-dev.2"
+    version: "1.0.0-dev.3"
   fake_async:
     dependency: transitive
     description:

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: darttindie
 description: Simple Dart wrapper for Tindie Order API
-version: 1.0.0-dev.2
+version: 1.0.0-dev.3
 homepage: https://github.com/enwi/DartTindie
 
 environment: