rebuild, prep for release

tbrowder · Jan 25, 2024 · 24621b4 · 24621b4
1 parent 11a0144
commit 24621b4
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/Changes b/Changes
@@ -1,6 +1,7 @@
 Revision history for Mi6-Helper
 
 {{$NEXT}}
+    - Add warning about issue #11
 
 0.11.1  2023-10-24T21:03:25-05:00
     - Major improvements:

diff --git a/README.md b/README.md
@@ -9,11 +9,13 @@ SYNOPSIS
 ========
 
     use Mi6::Helper
-
     $ mi6-helper new=Foo::Bar  # uses the 'provides' text in hidden file 
                                # '.Foo-Bar' (recommended method)
 
-**Easily** create the template for a new Raku module repository for management by `App::Mi6` with modifications including:
+**WARNING** There is a serious bug in the current version: it is unable to to correctly handle a desired module name with mixed '::' and hyphens ('-'). An issue has been filed, but, unless a user needs it soon, a fix will be delayed. A work-around is to manually make the necessary changes after the failure message. Please comment in the issue entry (#11) if a fix is important for your current project.
+====================================================================================================================================================================================================================================================================================================================================================================================================================
+
+in the desired **Easily** create the template for a new Raku module repository for management by `App::Mi6` with modifications including:
 
   * Published in the **Zef** Raku module ecosystem
 

diff --git a/docs/README.rakudoc b/docs/README.rakudoc
@@ -8,11 +8,19 @@ B<Mi6::Helper> - An aid for converting Raku modules to use B<App::Mi6>
 
 =begin code
 use Mi6::Helper
-
 $ mi6-helper new=Foo::Bar  # uses the 'provides' text in hidden file 
                            # '.Foo-Bar' (recommended method)
 =end code
 
+=head1 B<WARNING> There is a serious bug in the current version: it is
+unable to to correctly handle a desired module name with 
+mixed '::' and hyphens ('-'). An issue has been filed, but, unless a
+user needs it soon, a fix will be delayed. A work-around is to manually
+make the necessary changes after the failure message. Please comment
+in the issue entry (#11) if a fix is important for your current project.
+
+
+in the desired 
 B<Easily> create the template for a new Raku module repository for
 management by C<App::Mi6> with modifications including: