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

Documentation is 1.4.2 #434

Open
padreputativo opened this issue Oct 28, 2020 · 13 comments
Open

Documentation is 1.4.2 #434

padreputativo opened this issue Oct 28, 2020 · 13 comments

Comments

@padreputativo
Copy link

padreputativo commented Oct 28, 2020

Documentation has been 2 years without updating. Please update this to 1.5.0

https://github.com/tmijs/docs/tree/gh-pages/_posts/v1.4.2

https://github.com/tmijs/docs/tree/gh-pages/_posts/

@dkonopka
Copy link

@AlcaDesign it would be great to see updated documentation 🙏

@EmanSza
Copy link

EmanSza commented Jan 3, 2022

Documentation still needs to be updated, we are on 1.8 and documentation is still on 1.4.2, unacceptable if a maintainer cannot keep documentation fresh
If the maintainer cannot actively keep the docs updated he should find another maintainer more passionate to do the work, while I am aware that it is not a paid job to maintain tmi.js and many other open-source projects, This project is the discord.js of twitch and even if you try searching for other options the only one that comes up is tmi.js

@yurei-dll
Copy link

This. I'm looking for up-to-date docs on the events, and its very frustrating seeing them out of date. By three damn years, at that.

@evilangelmd
Copy link

Documentation still needs to be updated, we are on 1.8 and documentation is still on 1.4.2, unacceptable if a maintainer cannot keep documentation fresh If the maintainer cannot actively keep the docs updated he should find another maintainer more passionate to do the work, while I am aware that it is not a paid job to maintain tmi.js and many other open-source projects, This project is the discord.js of twitch and even if you try searching for other options the only one that comes up is tmi.js

you are welcome to make docs up-to-date

@padreputativo
Copy link
Author

padreputativo commented Aug 6, 2022

Yeah sure i will work for free in a multibillion company. Sure.

Lets fork it.

@yurei-dll
Copy link

you are welcome to make docs up-to-date

My brother in Christ. If it was that easy, this wouldn't even be a thread...

@evilangelmd
Copy link

Yeah sure i will work for free in a multibillion company. Sure.

Lets fork it.

why do you think tmijs is affiliated to twitch?

@yurei-dll
Copy link

why do you think tmijs is affiliated to twitch?

If you're referring to what EmanSza said,

This project is the discord.js of twitch

They were just making a comparison.
If you're unfamiliar with Discord.js you can check it out here

@padreputativo
Copy link
Author

padreputativo commented Aug 6, 2022

Memories of reading something like "twitch paid to someone to create a js library" that could be the reason is now a dead project... If they done it willing to earn money with it and the money never came up... they could let the project dead until they get paid again... And things like this... It looks pretty official for me:

https://dev.twitch.tv/docs/irc/get-started
https://discuss.dev.twitch.tv/t/timeout-with-tmi-js/37417

I always thought it was a kind of Amazon's trick to pay less or do not make themselves responsible of the code or whatever twisted reason

There is another library, for those who are curious:
https://d-fischer.github.io/twitch/ Alca Edit: Twurple (@twurple/chat) is the updated version of "twitch" https://twurple.js.org/

From my side, i'm done with js and browsers. It was a huge mistake to use the web for my bot.

@AlcaDesign
Copy link
Member

This library was not a commissioned by Twitch. It is not associated or affiliated with Twitch. It's an open source project.

@yurei-dll
Copy link

Okay. So is there a reason the docs aren't being updated? Because I feel like you just glossed over that.

@StunningRob
Copy link

StunningRob commented Aug 7, 2022 via email

@AlcaDesign
Copy link
Member

A lot of documentation has been added to the types.d.ts file. This file is very incomplete and broken but it's at least a place to coherently put the docs which can be used to generate new documentation. Events still need to be added.

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

No branches or pull requests

7 participants