Skip to content
This repository has been archived by the owner on Jan 8, 2022. It is now read-only.

chore: update readme #45

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

LiamTownsley
Copy link

Please describe the changes this PR makes and why it should be merged:
Update README.md with a little infromation by @almostSouji so people can see what this repository is at a glance, without having to go to Discussions.

Status and versioning classification:

  • This PR only includes non-code changes, like changes to documentation, README, etc.

update readme.md with a little infromation by @almostSouji so people can see what this repository is at a glance
README.md Outdated Show resolved Hide resolved
@kyranet kyranet requested review from iCrawl and vladfrangu July 1, 2021 17:01
includes change suggestion by @kyranet

Co-authored-by: Antonio Román <[email protected]>
@LiamTownsley LiamTownsley requested a review from kyranet July 1, 2021 17:07
Copy link

@splatterxl splatterxl left a comment

Choose a reason for hiding this comment

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

Shouldn't the -nexts be changed to -modules in this? Also, I believe the explanation is now incorrect as the name and description of the repository has changed.

@@ -14,6 +14,11 @@

## Status: pre-alpha

The idea behind `-next` is to rewrite the entire library in [TypeScript](https://www.typescriptlang.org) to make use of type safety and other features during development. We will still release it as a JavaScript library in the npm registry.

Being a full rewrite this will be a bit of a larger undergoing, so we encapsulate it in its own repository. Discord.js version 13 is in its finishing strides over at https://github.com/discordjs/discord.js . We do currently not have a roadmap or estimate on a release date for the rewrite under -next.
Copy link

@splatterxl splatterxl Jul 27, 2021

Choose a reason for hiding this comment

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

Suggested change
Being a full rewrite this will be a bit of a larger undergoing, so we encapsulate it in its own repository. Discord.js version 13 is in its finishing strides over at https://github.com/discordjs/discord.js . We do currently not have a roadmap or estimate on a release date for the rewrite under -next.
Being a full rewrite this will be a bit of a larger undergoing, so we encapsulate it in its own repository. While this rewrite is being developed, it is recommended to use [the main package](https://github.com/discordjs/discord.js) instead, as there is more API coverage in that library. We do currently not have a roadmap or estimate on a release date for the rewrite under `-modules`.

@Jiralite
Copy link
Member

Jiralite commented Aug 7, 2021

The discord.js version 13 text needs updating since it's released! Also, changing the contributing link to use the main branch would be a bonus! #50

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants