Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md #313

Closed
wants to merge 3 commits into from
Closed

Updated README.md #313

wants to merge 3 commits into from

Conversation

that-ar-guy
Copy link

@that-ar-guy that-ar-guy commented Nov 17, 2024

Description

This pull request enhances the project documentation to improve readability, structure, and user accessibility. It introduces clear subheadings, formatted sections, and enriched content for ease of use.

Related Issue

fixes: #254

Proposed Changes

  • Added Subheadings: Introduced new sections (e.g., "Why Choose Salam," "Features," "Installation") for better readability.
  • Enhanced Formatting: Used consistent formatting for headings, code blocks, and lists.
  • License Inclusion: Explicitly mentioned the GNU General Public License v3.0 in documentation

Checklist

  • I have tested these changes locally.
  • My code follows the project's coding style guidelines.
  • I have reviewed my own code to ensure quality.
  • Unnecessary comments were removed.
  • Documentation has been updated.

Additional Notes

These updates aim to improve user engagement and reduce ambiguity in project setup and contribution guidelines. Suggestions for further refinement are welcome!

@github-actions github-actions bot added documentation Improvements or additions to documentation repo labels Nov 17, 2024
@jbampton jbampton added this to the November milestone Nov 18, 2024
@jbampton jbampton marked this pull request as draft November 18, 2024 00:52
@jbampton jbampton assigned jbampton and unassigned BaseMax Nov 18, 2024
Copy link
Member

@jbampton jbampton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@that-ar-guy that-ar-guy closed this by deleting the head repository Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add 💄 to our README: Can you make the README better ?
3 participants