tmi.js icon indicating copy to clipboard operation
tmi.js copied to clipboard

Documentation is 1.4.2

Open padreputativo opened this issue 3 years ago • 13 comments

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/

padreputativo avatar Oct 28 '20 11:10 padreputativo

@AlcaDesign it would be great to see updated documentation 🙏

dkonopka avatar Jul 21 '21 10:07 dkonopka

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

EmanSza avatar Jan 03 '22 18:01 EmanSza

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.

yurei-dll avatar Jul 06 '22 20:07 yurei-dll

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

evilangelmd avatar Aug 06 '22 13:08 evilangelmd

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

Lets fork it.

padreputativo avatar Aug 06 '22 14:08 padreputativo

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...

yurei-dll avatar Aug 06 '22 14:08 yurei-dll

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

Lets fork it.

why do you think tmijs is affiliated to twitch?

evilangelmd avatar Aug 06 '22 14:08 evilangelmd

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

yurei-dll avatar Aug 06 '22 14:08 yurei-dll

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.

padreputativo avatar Aug 06 '22 14:08 padreputativo

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

AlcaDesign avatar Aug 06 '22 18:08 AlcaDesign

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

yurei-dll avatar Aug 07 '22 14:08 yurei-dll

Probably because people are busy! I'm thankful this is maintained and here for everyone to use and enjoy. I'll take a great tool and non-updated docs over no-tool any day!

StunningRob avatar Aug 07 '22 15:08 StunningRob

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.

AlcaDesign avatar Aug 07 '22 20:08 AlcaDesign