From bb54478b123b3c6ae3fee25a3721a5e9379e074f Mon Sep 17 00:00:00 2001
From: Parker Lougheed <parlough@gmail.com>
Date: Mon, 29 Jan 2024 14:23:12 -0600
Subject: [PATCH] Fix README formatting (#92)

---
 CHANGELOG.md |  4 ++++
 README.md    | 32 ++++++++++++++++----------------
 pubspec.yaml |  5 +++--
 3 files changed, 23 insertions(+), 18 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index c42f1bc..28e51bc 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 1.3.1-wip
+
+* Fixed README rendering on pub.dev and API docs.
+
 ## 1.3.0
 
 * Updated to use Unicode 15.0.0.
diff --git a/README.md b/README.md
index e3bef5c..38a2d3b 100644
--- a/README.md
+++ b/README.md
@@ -77,7 +77,7 @@ so they cannot be used safely on a sequence of characters.
 
 Grapheme clusters have varying length in the underlying representation,
 so operations on a [`Characters`][Characters] sequence cannot be index based.
-Instead the [`CharacterRange`][CharacterRange] *iterator*
+Instead, the [`CharacterRange`][CharacterRange] *iterator*
 provided by [`Characters.iterator`][Characters.iterator]
 has been greatly enhanced.
 It can move both forwards and backwards,
@@ -93,30 +93,30 @@ Example:
 
 ```dart
 // Using String indices.
-String firstTagString(String source) {
-  var start = string.indexOf("<") + 1;
+String? firstTagString(String source) {
+  var start = source.indexOf('<') + 1;
   if (start > 0) {
-    var end = string.indexOf(">", start);
+    var end = source.indexOf('>', start);
     if (end >= 0) {
-	    return string.substring(start, end);
+      return source.substring(start, end);
     }
   }
   return null;
 }
 
 // Using CharacterRange operations.
-Characters firstTagCharacters(Characters source) {
-  var range = source.findFirst("<".characters);
-  if (range != null && range.moveUntil(">".characters)) {
+Characters? firstTagCharacters(Characters source) {
+  var range = source.findFirst('<'.characters);
+  if (range != null && range.moveUntil('>'.characters)) {
     return range.currentCharacters;
   }
   return null;
 }
 ```
 
-[ByteBuffer]: https://api.dart.dev/stable/2.0.0/dart-typed_data/ByteBuffer-class.html	"ByteBuffer class"
-[CharacterRange.moveNext]:  https://pub.dev/documentation/characters/latest/characters/CharacterRange/moveNext.html "CharacterRange.moveNext"
-[CharacterRange]:  https://pub.dev/documentation/characters/latest/characters/CharacterRange-class.html "CharacterRange class"
+[ByteBuffer]: https://api.dart.dev/dart-typed_data/ByteBuffer-class.html "ByteBuffer class"
+[CharacterRange.moveNext]: https://pub.dev/documentation/characters/latest/characters/CharacterRange/moveNext.html "CharacterRange.moveNext"
+[CharacterRange]: https://pub.dev/documentation/characters/latest/characters/CharacterRange-class.html "CharacterRange class"
 [Characters constructor]: https://pub.dev/documentation/characters/latest/characters/Characters/Characters.html "Characters constructor"
 [Characters.iterator]: https://pub.dev/documentation/characters/latest/characters/Characters/iterator.html "CharactersRange get iterator"
 [Characters.replaceAll]: https://pub.dev/documentation/characters/latest/characters/Characters/replaceAll.html "Characters.replaceAlle"
@@ -126,8 +126,8 @@ Characters firstTagCharacters(Characters source) {
 [Code Units]: https://unicode.org/glossary/#code_unit "Unicode Code Units"
 [Glyphs]: https://unicode.org/glossary/#glyph "Unicode Glyphs"
 [Grapheme Clusters]: https://unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries "Unicode (Extended) Grapheme Cluster"
-[Iterable]: https://api.dart.dev/stable/2.0.0/dart-core/Iterable-class.html	"Iterable class"
-[Runes]: https://api.dart.dev/stable/2.0.0/dart-core/Runes-class.html	"Runes class"
-[String]: https://api.dart.dev/stable/2.0.0/dart-core/String-class.html	"String class"
-[Uint16List]: https://api.dart.dev/stable/2.0.0/dart-typed_data/Uint16List-class.html	"Uint16List class"
-[Uint8List]: https://api.dart.dev/stable/2.0.0/dart-typed_data/Uint8List-class.html	"Uint8List class"
+[Iterable]: https://api.dart.dev/dart-core/Iterable-class.html "Iterable class"
+[Runes]: https://api.dart.dev/dart-core/Runes-class.html "Runes class"
+[String]: https://api.dart.dev/dart-core/String-class.html "String class"
+[Uint16List]: https://api.dart.dev/dart-typed_data/Uint16List-class.html "Uint16List class"
+[Uint8List]: https://api.dart.dev/dart-typed_data/Uint8List-class.html "Uint8List class"
diff --git a/pubspec.yaml b/pubspec.yaml
index bd4803b..63928b9 100644
--- a/pubspec.yaml
+++ b/pubspec.yaml
@@ -1,6 +1,7 @@
 name: characters
-version: 1.3.0
-description: String replacement with operations that are Unicode/grapheme cluster aware.
+version: 1.3.1-wip
+description: >-
+  String replacement with operations that are Unicode/grapheme cluster aware.
 repository: https://github.com/dart-lang/characters
 
 environment: