Release 1.3.1

.gitignore

@@ -131,6 +131,7 @@ dmypy.json
 
 # VSCode
 .vscode/
+*.code-workspace
 
 # Pre-commit
 .pre-commit-config.yaml

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.3.1
+
+- Optimization
+
 ## 1.3.0
 
 - Added: Flags to specify dotting style: end with dot, wrap in dots, use delimeter-dots, or any combination
@@ -13,7 +17,7 @@
 
 ## 1.1.1
 
-Cleanup
+- Cleanup
 
 ## 1.1.0
 

INTRODUCTION.md

@@ -1,7 +1,7 @@
 # CYRILLIC NUMERAL SYSTEM
 
 ## 1. Numerals
-Church numeral system (*further CU*) has individual letters assigned to represent numbers from 1 to 9 in registries from digits to hundreds, for a total of 27 numerals. There's no zero numeral.
+Cyrillic numeral system (*further CU*) has individual letters assigned to represent numbers from 1 to 9 in registries from digits to hundreds, for a total of 27 numerals. There's no zero numeral.
 
 CU|Arabic|CU|Arabic|CU|Arabic
 ---|---|---|---|---|---

README.md

@@ -24,26 +24,28 @@ See [Introduction](./INTRODUCTION.md) to learn about CU numeral system.
 	a = cunumbers.to_cu(1)
 
 	#   Convert a CU number to Arabic
-	#   Requires str, returns int
+	#   Requires non-empty str, returns int
 
 	b = cunumbers.to_arab("а҃")
 
-"Delimiter" and "plain" style numbers are supported in both directions. "Delimeter" style is default for CU-wise conversions.
+"Delimiter" and "plain" style numbers are supported in both directions. "Delimeter" style is default for CU-wise conversion.
 
-	#   Use CU_PLAIN flag to use "plain" style in CU-wise conversion
+Several falgs can be used with `to_cu()` method:
+
+	#   CU_PLAIN flag sets conversion to "plain" style
 
 	c = cunumbers.to_cu(111111, CU_PLAIN)
 
-	#   Use CU_NOTITLO flag to omit "titlo"
+	#   CU_NOTITLO flag omits "titlo" output
 
-	d = cunumbers.to_cu(11000, CU_PLAIN + CU_NOTITLO)
+	d = cunumbers.to_cu(11000, CU_PLAIN | CU_NOTITLO)
 
-	#   Use following flags in CU-wise conversion to add dot-styling:
+	#   Following flags control dot styling:
+	#
 	#   CU_ENDDOT - append dot at the end
 	#   CU_WRAPDOT - append dot at both ends
-	#   CU_DELIMDOT - add dot between each group in "delimeter" style.
-	#       Sets conversion to "delim" style.
-	#   CU_ALLDOT = combine CU_WRAPDOT and CU_DELIMDOT
+	#   CU_DELIMDOT - add dot separator between digit groups. Sets conversion to "delim" style
+	#   CU_ALLDOT - combine CU_WRAPDOT and CU_DELIMDOT
 
 
 ## Contributing

cunumbers/__init__.py

@@ -1 +1,10 @@
-from .cunumbers import *
+__all__ = [
+    "to_cu",
+    "to_arab",
+    "CU_PLAIN",
+    "CU_NOTITLO",
+    "CU_ENDDOT",
+    "CU_DELIMDOT",
+    "CU_WRAPDOT",
+    "CU_ALLDOT",
+]