buttons / github-buttons

:octocat: Unofficial github:buttons

Home Page:https://buttons.github.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Not for npm registry

ntkme opened this issue · comments

Hi @Ostera,

I noted that you have published my project to npm registry. I don't know what's your intention of doing it, but I would like to friendly remind you that this project is not for npm:

  1. This project do use npm, but it is only for installing build dependencies.
  2. Octicons is included in this project as a git submodule, which is a more friendly way to keep the code base clean, deal with licensing, and use GitHub Pages. npm won't install git submodules.
  3. Due to a technical limitation (#20), every single hosted copy of this project needs to change a hard-coded URL accordingly, while a real npm package should work out of box.

I will appreciate if you can unpublish this project from npm registry to avoid any further confusion.


P.S. I won't question your motives, as I don't see any violation of the license.

Hi! I'm currently working on a refactor to make it possible to include the button generation code in other projects where the DOM elements might not be available at the time of including the source (I.e. A React app that would render the a corresponding to a Stars button after the parsing was done by the buttons.js file).

Granted, I jumped the gun on publishing to secure the namespace. I'll unpublish, fork, and republish so there's no confusion as to what is the source of the published module.

Thanks for bringing this to my attention.