Add small example (#9)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 72ceefe..198373a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,10 @@
# Changelog
+## 0.3.1
+
+* Added small example in `example/main.dart`
+* Enabled pedantic lints and updated code to resolve issues.
+
## 0.3.0
* Updated API which does not expose the underlying string indices.
diff --git a/example/main.dart b/example/main.dart
new file mode 100644
index 0000000..65cda68
--- /dev/null
+++ b/example/main.dart
@@ -0,0 +1,21 @@
+import 'package:characters/characters.dart';
+
+// Small API examples. For full API docs see:
+// https://pub.dev/documentation/characters/latest/characters/characters-library.html
+main() {
+ String hi = 'Hi 🇩🇰';
+ print('String is "$hi"\n');
+
+ // Length.
+ print('String.length: ${hi.length}');
+ print('Characters.length: ${Characters(hi).length}\n');
+
+ // Skip last character.
+ print('String.substring: "${hi.substring(0, hi.length - 1)}"');
+ print('Characters.skipLast: "${Characters(hi).skipLast(1)}"\n');
+
+ // Replace characters.
+ Characters newHi =
+ Characters(hi).replaceAll(Characters('🇩🇰'), Characters('🇺🇸'));
+ print('Change flag: "$newHi"');
+}
diff --git a/pubspec.yaml b/pubspec.yaml
index 603ed58..be2d3a7 100644
--- a/pubspec.yaml
+++ b/pubspec.yaml
@@ -1,5 +1,5 @@
name: characters
-version: 0.3.0
+version: 0.3.1
description: String replacement with operations that are Unicode/grapheme cluster aware.
author: Dart Team <misc@dartlang.org>
homepage: https://www.github.com/dart-lang/characters
