Merge pull request #10 from lion-packages/documentation

Project Documentation

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Lion-Packages Community Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+-   Demonstrating empathy and kindness toward other people
+-   Being respectful of differing opinions, viewpoints, and experiences
+-   Giving and gracefully accepting constructive feedback
+-   Accepting responsibility and apologizing to those affected by our mistakes,
+    and learning from the experience
+-   Focusing on what is best not just for us as individuals, but for the overall
+    community
+
+Examples of unacceptable behavior include:
+
+-   The use of sexualized language or imagery, and sexual attention or advances of
+    any kind
+-   Trolling, insulting or derogatory comments, and personal or political attacks
+-   Public or private harassment
+-   Publishing others' private information, such as a physical or email address,
+    without their explicit permission
+-   Other conduct which could reasonably be considered inappropriate in a
+    professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+lion.packages.public@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.MD

@@ -0,0 +1,40 @@
+# Contributing to Lion-Packages Open-Source PHP Projects
+
+Thank you for considering contributing to our open-source projects! We strive to maintain a collaborative and welcoming environment for all contributors. Before submitting your contribution, please take a moment to review the following guidelines.
+
+## Contribution Guidelines
+
+1. **Mutual Respect**: Treat all community members with respect. We do not tolerate harassment or offensive behavior.
+
+2. **Adherence to PSR Standards**: Our PHP projects follow the standards defined by [PHP-FIG](https://www.php-fig.org/). Please ensure that your code complies with the relevant PSR standards.
+
+3. **Adherence to Lion-Packages Standards**: Our PHP projects also follow our own standards along with the PSR, lease [Lion-Packages Standards](https://lion-packages.vercel.app/standards).
+
+3. **Creating an Issue**: Before starting work on a new feature or bug fix, please open an issue to discuss it. This helps ensure that your contribution aligns with the project's goals and avoids duplication of effort.
+
+4. **Branching Strategy**: When contributing code, create a new branch off the `main` branch. Use a descriptive name for your branch that summarizes the changes you are making.
+
+5. **Pull Request Process**: When submitting a pull request, provide a clear and concise description of the changes you've made. Ensure that your code passes all tests and linting checks. If your pull request addresses an open issue, reference the issue number in the description.
+
+6. **Code Reviews**: All pull requests require review before merging. Be open to feedback and be willing to make changes based on reviewer suggestions.
+
+7. **Documentation**: If your contribution introduces new features or changes existing functionality, update the project's documentation accordingly.
+
+8. **Licensing**: By contributing to our projects, you agree to license your code under the same license as the project (typically [MIT License](https://opensource.org/licenses/MIT)). Ensure that any new files include the appropriate license header.
+
+## Getting Started
+
+To contribute to our projects, follow these steps:
+
+1. Fork the repository to your GitHub account.
+2. Clone the forked repository to your local machine.
+3. Create a new branch for your contribution.
+4. Make your changes and commit them with descriptive commit messages.
+5. Push your changes to your forked repository.
+6. Open a pull request from your branch to the `main` branch of the original repository.
+
+Thank you for contributing to Lion-Packages open-source projects! Your contributions help make our projects better for everyone.
+
+If you have any questions or need further assistance, feel free to reach out to us or refer to our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+---

README.md

@@ -1,18 +1,18 @@
 <p align="center">
   <a href="https://lion-client.vercel.app/" target="_blank">
-    <img
-         src="https://user-images.githubusercontent.com/56183278/230516080-096130be-e474-4f3a-a78a-44d3973ff715.png"
-         width="300"
-         alt="Lion-Framework Logo"
+    <img 
+        src="https://github.com/lion-packages/framework/assets/56183278/60871c9f-1c93-4481-8c1e-d70282b33254"
+        width="450" 
+        alt="Lion-Framework Logo"
     >
   </a>
 </p>
 
 <p align="center">
-  <img src="http://poser.pugx.org/lion/helpers/v" alt="Latest Stable Version">
-  <img src="http://poser.pugx.org/lion/helpers/downloads" alt="Total Downloads">
-  <img src="http://poser.pugx.org/lion/helpers/license" alt="License">
-  <img src="http://poser.pugx.org/lion/helpers/require/php" alt="PHP Version Require">
+  <img src="https://poser.pugx.org/lion/helpers/v" alt="Latest Stable Version">
+  <img src="https://poser.pugx.org/lion/helpers/downloads" alt="Total Downloads">
+  <img src="https://poser.pugx.org/lion/helpers/license" alt="License">
+  <img src="https://poser.pugx.org/lion/helpers/require/php" alt="PHP Version Require">
 </p>
 
 ## Install