0.0.2-beta

.vscode/changelog.code-snippets

@@ -0,0 +1,9 @@
+{
+  "changelog": {
+    "prefix": "changelog",
+    "body": [
+      "  - **${1:Summary} - [${2:Author}], [issue/${3:Issue #}] [pull/${4:PR #}]**\n\n    ${5:Detailed description}\n\n    [$2]: https://github.com/$2\n    [pull/$4]: https://github.com/EverlastingBugstopper/boxx/pull/$4\n    [issue/$3]: https://github.com/EverlastingBugstopper/boxx/issues/$3"
+    ],
+    "description": "changelog boilerplate"
+  }
+}

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## 🐛 0.0.2-beta
+
+### Fixes
+
+- **Properly display `Boxx` when content includes ANSI escapes - [EverlastingBugstopper], [issue/3] [pull/4]**
+
+  A common use case for eventual `Boxx` consumers will be displaying boxxed content with colors. Strings include [ANSI escapes](http://ascii-table.com/ansi-escape-sequences.php) which are then interpreted by terminals. Since there is more information, they require more bytes, which means the visual width must be calculated independently from the byte width. `Boxx` now strips ANSI escapes from strings when calculating the padding and margin for the content.
+
+  [EverlastingBugstopper]: https://github.com/EverlastingBugstopper
+  [pull/4]: https://github.com/EverlastingBugstopper/boxx/pull/4
+  [issue/3]: https://github.com/EverlastingBugstopper/boxx/issues/3
+
+### Maintenance
+
+- Some examples were added to the documentation.

Cargo.toml

@@ -8,7 +8,7 @@ license = "MIT/Apache-2.0"
 name = "boxx"
 readme = "README.md"
 repository = "https://github.com/EverlastingBugstopper/boxx"
-version = "0.0.1-alpha"
+version = "0.0.2-beta"
 
 [dependencies]
 console = "0.9"

README.md

@@ -1,6 +1,6 @@
 # Boxx
 
-_note: this library is still in early stages and updates may contain breaking changes_
+_note: this library is still in development and updates may contain breaking changes_
 
 Display informational boxes in the terminal.
 
@@ -10,7 +10,7 @@ Your `Cargo.toml` should include `boxx` as a dependency
 
 ```toml
 [dependencies]
-boxx = "0.0.1-alpha"
+boxx = "0.0.2-beta"
 ```
 
 ```rust

src/lib.rs

@@ -1,6 +1,6 @@
 #![deny(missing_docs)]
 #![deny(missing_debug_implementations)]
-#![doc(html_root_url = "https://docs.rs/boxx/0.0.1-alpha")]
+#![doc(html_root_url = "https://docs.rs/boxx/0.0.2-beta")]
 
 //! boxx
 //!