search

jozsefsallai / discord.js-minesweeper

Generate Minesweeper mine fields using Discord's spoiler tags.
MIT License
16 stars 4 forks source link

Add license badge and add discord.js as a dependency #1

Closed jayden8923 closed 5 years ago

jayden8923 commented 5 years ago

Remove

License

and add a badge

Also added discord.js as a dependency in package.json

jozsefsallai commented 5 years ago

yo! thanks for the PR, really nice! I didn't really want to overwhelm that area with badges, but I guess it won't take up too much space. I'd generally prefer having a separate section in the readme for license stuff (i.e. like here). But this solution works too. However, you might wanna remove the ToC entry for the license.

Also, not having discord.js as a dependency is intentional. You don't actually have to use this with discord.js, but that's the main field where you might want to use something like this. This library can be used in other environments too, like web apps (see: https://jozsefsallai.github.io/discord-minesweeper-generator/). There are two reasons why I opted for calling this library "discord.js-minesweeper". For one, I wanted to make it so that if someone searches for "discord.js minesweeper" (or similar terms), it will show up as the first search result. On the other hand, "discord-minesweeper" was already taken oof.

$ grep -rl 'discord.js' -a . --exclude-dir={node_modules,.git,.nyc_output}
./package.json
./README.md

as you can see, discord.js is nowhere actually used! so adding it as a dependency is unnecessary and would void the "zero-dependency" aim of the library.