rbren / rss-parser

A lightweight RSS parser, for Node and the browser
MIT License
1.38k stars 209 forks source link

ReadMe.Remove non-working Typescript code that is very confusing. #233

Open CookingWithCale opened 2 years ago

CookingWithCale commented 2 years ago

You should never, ever, copy and paste demo code and it doesn't compile. I write compilers, I've read RSS feeds for decades, but I can't figure out what you're code is even doing. You don't explain what 'baz' is, why I would need it. I understand that I can remove the non-working code and it will run and then maybe I'll figure out what you're talking about, but I can't really that when the code doesn't compile. How do I parse multiple RSS feeds? What is a Custom feed? Is that different than a regular feed? How is a custom feed different than a regular feed? The naming conventions here suck really bad. As an expert programmer, I should be able to look at your code and understand what does what, but I can't do that when you use generic placeholders and don't explain your nomiclature. When you use placeholders like Foo, Bar, they are supposed to be when you only require a generic placeholder. When you are dealing with concrete examples, you need to use ConcretePlaceholders. What does 'foo' mean?