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

Rewrite README - with new styling and shortened descriptions. #191

Merged
merged 16 commits into from Dec 8, 2021
Merged

Rewrite README - with new styling and shortened descriptions. #191

merged 16 commits into from Dec 8, 2021

Conversation

abhigyantrips
Copy link
Member

Summary

This PR closes #185, with the aim of making changes to the README inherited from discord.py.

The changes made to the README have mostly been related to the styling, and shortening of descriptions:

  • Delete of README.ja.rst (as discussed among contributors).
  • Change styling (to flat-square) and position of badges (now centered).
  • Convert the links at the bottom into a centered footer.
  • Change "Key Features" listed for the library (from the previously inherited pointers of discord.py).
  • Add website hyperlink/redirect to the banner of the README.
  • Shorten descriptions, move "Prefix Commands" example below "Application Commands".

Checklist

  • If code changes were made then they have been tested
    • I have updated the documentation to reflect the changes
    • I have formatted the code properly by running black .
  • This PR fixes an issue
  • This PR adds something new (e.g. new method or parameters)
  • This PR is a breaking change (e.g. methods or parameters removed/renamed)
  • This PR is not a code change (e.g. documentation, README, ...)

@shiftinv shiftinv added t: documentation Improvements or additions to documentation/examples t: meta Changes to the project itself (CI, configs, etc.) s: needs review Issue/PR is awaiting reviews labels Dec 8, 2021
@EQUENOS EQUENOS merged commit 8922cd6 into DisnakeDev:master Dec 8, 2021
Copy link
Contributor

@Bluenix2 Bluenix2 left a comment

Choose a reason for hiding this comment

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

Hello, I was the one who originally inspired the original issue and I think this is nice but it still doesn't clarify what makes disnake stand out.

What does disnake improve over discord.py? Why should someone pick disnake over another fork (or even discord.py itself)?

PS: You're mixing reStructuredText and Markdown headers

@Bluenix2
Copy link
Contributor

Bluenix2 commented Dec 8, 2021

Aaaaaahh too late sorry

@EQUENOS
Copy link
Member

EQUENOS commented Dec 8, 2021

You have a point, this readme doesn't "sell" disnake very well

@onerandomusername onerandomusername removed the s: needs review Issue/PR is awaiting reviews label Apr 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t: documentation Improvements or additions to documentation/examples t: meta Changes to the project itself (CI, configs, etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write a new readme
5 participants