1. 2

    I think this could use more motivation. I have never written a TODO app in js, but if the library illustrates something valuable, that might not matter.

    One note about code: render() has repeated calls to Object.keys(obj).

    1. 1

      Maybe “TODO” in the title is little unfortunate. It can be used for many things, render any kind of DOM elements. List, menus even single HTML elements. It’s like very small version of React or Vue.js with completely different architecture and logic.

      1. 2

        Yeah, TODO has an association with toy apps, so I’d drop that word. Looking back at the readme, you might not need any other changes.

        1. 1

          That is actually great suggestion!

    1. 6

      The point of Markdown is keeping it readable as plain text (and I frequently use that feature). This template – which uses HTML syntax everywhere – makes that very painful.

      1. 0

        I prefer HTML because I use it often. Also I needed HTML to center some elements. But I can easy make markdown alternative.. so people who prefer markdown could use it.

        1. 3

          The big issue for me is just the plaintext readability – often I am e.g. compiling a project and just doing cat README.md. So a README.md template should at least aim to keep most of the text readable as plaintext, IMHO.

          1. 3

            You are 100% right about the plaintext readability. Markdown is more readable than HTML.

      1. 2

        And here I thought that it would be a boilerplate stating how your project is moving to GitLab/gogs/gitea and that the GitHub repository is just a mirror.

        1. 1

          Unfortunately no. I stared the project before the news GitHub + Microsoft. I also made a copy https://gitlab.com/vladocar/boilerplate-readme-template. And yes, I’m angry that all my open source project are now under Microsoft. Should I go to GitLab? Who will guarantee that GitLab one day will be sold to Apple or other corporate. Should I do some private arrangements? I could but the point of all open source project is interaction with the community of developers. So I’m not sure what to do.

          1. 3

            I’m hoping we see federation (maybe with ActivityPub, maybe with something else) implemented in GitLab/gogs/gitea, so that it doesn’t matter so much for discoverability where your code is hosted. Currently a combination of repository/issues/wiki and emailing pull requests is fine for development, but not so good for discoverability.

            1. 3

              Until Microsoft shuts down the interactions, keep business as usual. Git makes it supremely easy to pull out if you have to.

              There are tools to transfer issues etc as well, I’m told.

              GitHub alone was a de-facto monopoly, just like Microsoft, so I don’t get the fuss. Sure, MS has a bad history, but it’s run differently now.

              1. 1

                It’s worthwhile to be proactive. I intend to gradually move to self-hosted as I have time, and make my old github repositories mirrors of the new self-hosted ones.

                The situation with Microsoft owning GitHub is not significantly worse than GitHub was before the acquisition, but it was already not great. It only took a change to tip things for a lot of people.

          1. 2

            The first time I read your sample README, for some reason I thought I had to install the template using npm :)

            Download & Installation

            $ npm i boilerplate-readme-template

            1. 2

              Ha ha we are super addicted to console tools that we forget that we can simply download the project or copy paste it :)