Merge branch 'meta/make-github-pretty'

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Overview
+
+This document describes various policies (most notably, the standards
+of conduct) for the Dancer core developers and broad community.
+
+This is what we expect from our community and ourselves and these are
+the standards of behavior we set forth in order to make sure the community
+remains a safe space for all of its members, without exception.
+
+# Standards of Conduct
+
+These standards apply anywhere the community comes together as a group.
+This includes, but is not limited to, the Dancer IRC channel, the Dancer
+mailing list, Dancer hackathons, and Dancer conferences.
+
+- Always be civil.
+- Heed the moderators.
+- Abuse is not tolerated.
+
+Civility is simple: stick to the facts while avoiding demeaning remarks and
+sarcasm. It is not enough to be factual. You must also be civil. Responding
+in kind to incivility is not acceptable.
+
+If the list moderators tell you that you are not being civil, carefully
+consider how your words have appeared before responding in any way. You may
+protest, but repeated protest in the face of a repeatedly reaffirmed decision
+is not acceptable.
+
+Unacceptable behavior will result in a public and clearly identified warning.
+Repeated unacceptable behavior will result in removal from the mailing list and
+revocation of any commit bit. The first removal is for one month. Subsequent
+removals will double in length. After six months with no warning, a user's ban
+length is reset. Removals, like warnings, are public.
+
+The list of moderators consists of all active core developers. This includes,
+in alphabetical order, Alberto Simões, David Precious, Jason Crome, Mickey
+Nasriachi, Peter Mottram, Russell Jenkins, Sawyer X, Stefan Hornburg (Racke),
+and Yanick Champoux.
+
+This list might additionally grow to active members of the community who have
+stepped up to help handle abusive behavior. If this should happen, this
+document would be updated to include their names.
+
+Additionally, it's important to understand the self-regulating nature we
+foster at the Dancer community. This means anyone and everyone in the
+community - in the channel, on the list, at an event - has the ability to
+call out unacceptable behavior and incivility to others in the community.
+
+Moderators are responsible for issuing warnings and take disciplinary actions,
+but anyone may - and is encouraged - to publicly make note of unacceptable
+treatment of others.
+
+As a core principle, abuse is never tolerated. One cannot berate, insult,
+debase, deride, put down, or vilify anyone, or act towards anyone in a way
+intending to hurt them.
+
+The community specifically considers as abuse any attempts to otherize anyone 
+by any individual characteristic, including, but not limited to, their 
+technical skill, knowledge or by their age, colour, disability, gender, 
+language, national or social origin, political or other opinion, race, 
+religion, sex, or sexual orientation.
+
+The community aims to maintain a safe space for everyone, in any forum it
+has. If you ever feel this core principle has been compromised, you are strongly
+urged to contact a moderator. We are always here.
+
+Remember, this is **your** community, as much as it is anyone else's.
+
+# CREDITS
+
+This policy has been adopted and adapted from the policy available for
+the Perl language development, provided by **p5p** (the Perl 5 Porters).
+
+The original inspiration policy document can be read at [perlpolicy](https://metacpan.org/pod/perlpolicy).

LICENSE

@@ -0,0 +1,3 @@
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+

README.md

@@ -1,76 +1,84 @@
-# NAME
-
-Dancer2 - Lightweight yet powerful web application framework
-
-# VERSION
-
-version 1.1.0
-
-# DESCRIPTION
-
-Dancer2 is the new generation of [Dancer](https://metacpan.org/pod/Dancer), the lightweight web-framework for
-Perl. Dancer2 is a complete rewrite based on [Moo](https://metacpan.org/pod/Moo).
+<p align="center">
+  <a href="https://perldancer.org/">
+    <img src="https://crome-plated.com/images/dancer-logo.png" alt="Perl Dancer logo">
+  </a>
+</p>
+
+<p align="center">
+  Dancer2 is a lightweight yet powerful web application framework
+  written in Perl.
+  <br>
+  <a href="https://metacpan.org/pod/Dancer2%3A%3ATutorial">Tutorial</a>
+  ·
+  <a href="https://metacpan.org/pod/Dancer2%3A%3AManual">Manual</a>
+  ·
+  <a href="https://github.com/PerlDancer/Dancer2/discussions">Discussion Forums</a>
+  ·
+  <a href="https://github.com/PerlDancer/Dancer2/wiki">Public Wiki</a>
+  ·
+  <a href="http://lists.preshweb.co.uk/mailman/listinfo/dancer-users">Mailing List</a>
+</p><br>
+
+Dancer2 is the evolution of [Dancer](https://metacpan.org/pod/Dancer)
+and is based on on [Moo](https://metacpan.org/pod/Moo), a lightweight
+object framework for Perl.
 
 Dancer2 can optionally use XS modules for speed, but at its core remains
-fatpackable (packable by [App::FatPacker](https://metacpan.org/pod/App%3A%3AFatPacker)) so you could easily deploy Dancer2
-applications on hosts that do not support custom CPAN modules.
+fatpackable (via [App::FatPacker](https://metacpan.org/pod/App%3A%3AFatPacker)), allowing
+you to easily deploy Dancer2 applications in environments that do not support custom
+installations of CPAN modules.
 
 Dancer2 is easy and fun:
 
     use Dancer2;
     get '/' => sub { "Hello World" };
-    dance; 
-
-This is the main module for the Dancer2 distribution. It contains logic for
-creating a new Dancer2 application.
+    dance;
 
 ## Documentation Index
 
-Documentation on Dancer2 is split into several sections. Below is a
-complete outline on where to go for help.
+Documentation for Dancer2 is split into several sections:
 
 - Dancer2 Tutorial
 
-    If you are new to the Dancer approach, you should start by reading
-    our [Dancer2::Tutorial](https://metacpan.org/pod/Dancer2%3A%3ATutorial).
+    If you've never danced before, you should start by reading
+    our [tutorial](https://metacpan.org/pod/Dancer2%3A%3ATutorial).
 
-- Dancer2 Manual
+- Manual
 
-    [Dancer2::Manual](https://metacpan.org/pod/Dancer2%3A%3AManual) is the reference for Dancer2. Here you will find
-    information on the concepts of Dancer2 application development and
-    a comprehensive reference to the Dancer2 domain specific
+    The [Dancer2::Manual](https://metacpan.org/pod/Dancer2%3A%3AManual) is the definitive reference for Dancer2. Here you will find
+    information on the concepts of Dancer2 application development and a comprehensive reference to the Dancer2 domain specific
     language.
 
-- Dancer2 Keywords
+- Keyword Guide
 
-    The keywords for Dancer2 can be found under [DSL Keywords](https://metacpan.org/pod/Dancer2%3A%3AManual#DSL-KEYWORDS).
+    The complete list of keywords for Dancer2 is documented in the [DSL Keywords](https://metacpan.org/pod/Dancer2%3A%3AManual#DSL-KEYWORDS)
+    guide.
 
-- Dancer2 Deployment
+- Deployment
 
     For configuration examples of different deployment solutions involving
-    Dancer2 and Plack, refer to [Dancer2::Manual::Deployment](https://metacpan.org/pod/Dancer2%3A%3AManual%3A%3ADeployment).
+    Dancer2 and Plack, refer to [the deployment guide](https://metacpan.org/pod/Dancer2%3A%3AManual%3A%3ADeployment).
 
-- Dancer2 Cookbook
+- Cookbook
 
     Specific examples of code for real-life problems and some 'tricks' for
-    applications in Dancer can be found in [Dancer2::Cookbook](https://metacpan.org/pod/Dancer2%3A%3ACookbook)
+    applications in Dancer2 can be found in [the Cookbook](https://metacpan.org/pod/Dancer2%3A%3ACookbook)
 
-- Dancer2 Config
+- Configuration
 
     For configuration file details refer to [Dancer2::Config](https://metacpan.org/pod/Dancer2%3A%3AConfig). It is a
     complete list of all configuration options.
 
-- Dancer2 Plugins
+- Plugins
 
-    Refer to [Dancer2::Plugins](https://metacpan.org/pod/Dancer2%3A%3APlugins) for a partial list of available Dancer2
-    plugins. Note that although we try to keep this list up to date we
-    expect plugin authors to tell us about new modules.
+    Refer to [Dancer2::Plugins](https://metacpan.org/pod/Dancer2%3A%3APlugins) for a curated list of Dancer2
+    plugins, or [search MetaCPAN](https://metacpan.org/search?q=Dancer2%3A%3APlugin) for a complete list.
 
     For information on how to author a plugin, see ["Writing the plugin" in Dancer2::Plugin](https://metacpan.org/pod/Dancer2%3A%3APlugin#Writing-the-plugin).
 
-- Dancer2 Migration guide
+- Dancer2 Migration Guide
 
-    [Dancer2::Manual::Migration](https://metacpan.org/pod/Dancer2%3A%3AManual%3A%3AMigration) provides the most up-to-date instruction on
+    [The migration guide](https://metacpan.org/pod/Dancer2%3A%3AManual%3A%3AMigration) provides the most up-to-date instructions on
     how to convert a Dancer (1) based application to Dancer2.
 
 ### Other Documentation
@@ -85,7 +93,7 @@ complete outline on where to go for help.
 
 - GitHub Wiki
 
-    Our [GitHub wiki](https://github.com/PerlDancer/Dancer2/wiki) has community-contributed
+    Our [wiki](https://github.com/PerlDancer/Dancer2/wiki) has community-contributed
     documentation, as well as other information that doesn't quite fit within
     this manual.
 
@@ -101,23 +109,24 @@ complete outline on where to go for help.
     broken, unused, or outdated code from the Dancer2 codebase. This policy is critical
     for guiding and shaping future development of Dancer2.
 
-# SECURITY REPORTS
+# Security Reports
 
 If you need to report a security vulnerability in Dancer2, send all pertinent
-information to [[email protected]](mailto:[email protected]). These matters are taken
-extremely seriously, and will be addressed in the earliest timeframe possible.
+information to [[email protected]](mailto:[email protected]), or report it
+via the GitHub security tool. These reports will be addressed in the earliest possible
+timeframe.
 
-# SUPPORT
+# Support
 
 You are welcome to join our mailing list.
 For subscription information, mail address and archives see
 [http://lists.preshweb.co.uk/mailman/listinfo/dancer-users](http://lists.preshweb.co.uk/mailman/listinfo/dancer-users).
 
 We are also on IRC: #dancer on irc.perl.org.
 
-# AUTHORS
+# Authors
 
-## CORE DEVELOPERS
+## Dancer Core Team
 
     Alberto Simões
     Alexis Sukrieh
@@ -133,12 +142,12 @@ We are also on IRC: #dancer on irc.perl.org.
     Stefan Hornburg (Racke)
     Yanick Champoux
 
-## CORE DEVELOPERS EMERITUS
+## Core Team Emeritus
 
     David Golden
     Steven Humphrey
 
-## CONTRIBUTORS
+## Contributors
 
     A. Sinan Unur
     Abdullah Diab
@@ -290,13 +299,13 @@ We are also on IRC: #dancer on irc.perl.org.
     xenu
     Yves Orton
 
-# AUTHOR
+# Author
 
 Dancer Core Developers
 
-# COPYRIGHT AND LICENSE
+# Copyright and License
 
-This software is copyright (c) 2023 by Alexis Sukrieh.
+This software is copyright (c) 2024 by Alexis Sukrieh.
 
 This is free software; you can redistribute it and/or modify it under
 the same terms as the Perl 5 programming language system itself.

SECURITY.md

@@ -0,0 +1,4 @@
+If you need to report a security vulnerability in Dancer2, send all pertinent
+information to [[email protected]](mailto:[email protected]), or report it
+via the GitHub security tool. These reports will be addressed in the earliest possible
+timeframe.

dist.ini

@@ -76,6 +76,3 @@ dir = share
 [Encoding]
 encoding = bytes
 match    = \.(png|ico|jpg)$ ; these are all binary files
-
-[ ReadmeAnyFromPod / MarkdownInRoot ]
-filename = README.md