> On Nov 3, 2021, at 3:44 PM, Harley Swick <fancyc...@mycanofbeans.com> wrote:
> 
> There is a different cmark egg for Chicken 4. Since my additions are 
> significantly larger than
> the total of the old egg, I didn't feel it was fair to drop a bunch of 
> strange code on someone
> who may not want to be stuck maintaining it. I have added aliases to make 
> this egg
> a compatible replacement for users upgrading from 4 to 5. I don't foresee any 
> issues with conflicts since
> this egg only works with Chicken 5.

Harley,

Welcome. I would recommend adding a similar explanation to your wiki page, just 
that the 5 egg is a totally new codebase but has backwards-compatibility via 
aliases. Probably not critical since 4.x is old now, but might be nice if 
anyone is curious.

It’s also customary to add license information and a simple changelog / version 
history inline. In this case it would just be e.g. “0.1.0 Initial release for 
Chicken 5” or something like that. Check out other eggs for details.

Jim

Reply via email to