- Updated package info

Author: Herohtar

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.3.0] - 2018-07-10
+
+* Implemented the remaining `word` API calls
+* Added example package (incomplete)
+* Minor internal API adjustments
+
 ## [0.2.0] - 2018-07-10
 
 * Implemented all `wordList` API calls

README.md

@@ -1,5 +1,29 @@
 # wordnik
 
-Wordnik API for Dart. (See <https://developer.wordnik.com/>)
+### Wordnik API for Dart
 
-Currently, only `account`, `wordList`, `wordLists`, and `words` API calls are implemented.
+Work in progress. Currently, all object models and API calls have been implemented, but with minimal testing. API signatures are likely to change as development continues.
+
+#### Related:
+* Wordnik: <https://www.wordnik.com/>
+* Wordnik API: <https://developer.wordnik.com/docs>
+
+
+## Basic usage
+```dart
+import 'package:wordnik/wordnik.dart';
+
+void main() async {
+
+  Wordnik wordnik = Wordnik('YOUR_API_KEY');
+
+  WordObject randomWord = await wordnik.getRandomWord(
+    includePartOfSpeech: 'verb',
+    minLength: 6,
+    maxLength: 10
+  );
+
+  print(randomWord.word);
+
+}
+```

pubspec.yaml

@@ -1,6 +1,6 @@
 name: wordnik
 description: Wordnik API for Dart
-version: 0.2.0
+version: 0.3.0
 author: "Herohtar <[email protected]>"
 homepage: https://github.com/herohtar/wordnik-dart