Merge pull request #2 from Diapolo10/nightly

[PATCH] Fixed a mistake in README example code
Diapolo10 · Dec 1, 2021 · d1d44ef · d1d44ef
2 parents fc9155c + 543621f
commit d1d44ef
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,5 @@
 
-# IPlib3 Change Log
+# Escapyde Change Log
 
 All notable changes to this project will be documented in this file.
 
@@ -50,7 +50,7 @@ Lorem Ipsum dolor sit amet.
 <!--
 _______________________________________________________________________________
 
-## [0.2.3] - YYYY-MM-DD
+## [0.1.1] - YYYY-MM-DD
 
 First official documentation.
 
@@ -68,7 +68,26 @@ First official documentation.
 
 _______________________________________________________________________________
 
-## [0.1.0] - 2021-05-01
+## [0.1.1] - 2021-12-01
+
+A hotfix release that fixes a problem in the README example code, and adds a screenshot of the code running.
+
+### Added
+
+- Added a screenshot of the example code running in IPython
+
+### Changed
+
+- Updated the localisation files
+
+### Fixed
+
+- Fixed a mistake in the `README.md` example code related to string formatters
+- Fixed the package name in `CHANGELOG.md`
+
+_______________________________________________________________________________
+
+## [0.1.0] - 2021-12-01
 
 This is the beginning of the changelog. Previously made commits have not been
 tracked, and there are no plans to distinguish them. You may consider this

diff --git a/README.md b/README.md
@@ -26,7 +26,11 @@ from escapyde.examples.text import SKULL
 
 some_text = "Hello, world!"
 
-print(f"I want to print this red: {escapyde.FRED | some_text:r}, and this yellow: {escapyde.FYELLOW | 'Hi!'}.")
+print(f"I want to print this red: {escapyde.FRED | some_text}, and this yellow: {escapyde.FYELLOW | 'Hi!'}.")
 
 print(f"Here's a cyan skull:\n{escapyde.FCYAN | SKULL}")
 ```
+
+As can be seen, the example works perfectly fine:
+
+![A screenshot of the example run on IPython on Windows.](./docs/readme_screenshot.png "Not bad, not bad at all.")
diff --git a/docs/readme_screenshot.png b/docs/readme_screenshot.png
diff --git a/pyproject.toml b/pyproject.toml
@@ -17,7 +17,7 @@ __init__.py:F401,F403,F405\
 
 [tool.poetry]
 name = 'escapyde'
-version = '0.1.0'
+version = '0.1.1'
 description = "Yet another ANSI escape sequence library for Python - now modernised!"
 
 authors = ["Lari Liuhamo <[email protected]>",]