How to add a package to bower registry

Today I noticed a nice icon project: Code Icons. I decided to contribute adding a bower.json cause I would like to use it and it is int its TODO list.

bower.json

I just created a file bower.json like the following

{
  "name": "codeicons",
  "main": [
    "./dist/css/code-icons.css",
    "./dist/css/code-icons.css.map",
    "./dist/css/code-icons.min.css",
    "./fonts/Code-Icons.eot",
    "./fonts/Code-Icons.svg",
    "./fonts/Code-Icons.ttf",
    "./fonts/Code-Icons.woff"
  ],
  "homepage": "http://mabrasil.github.io/getcodeicons/",
  "authors": [
    "Matheus Brasil"
  ],
  "description": "An icon set of programming languages, frameworks, and coding tools.",
  "keywords": [
    "icons"
  ],
  "license": "MIT",
  "ignore": [
    "**/.*",
    "node_modules",
    "gulpfile.js",
    "npm-debug.log",
    "src"
  ]
}

Then, you need to have at list a semantic version named git tag, here it is: v1.1.0 and you are ready to register it.

The command syntax is

bower register <my-package-name> <git-endpoint>

Since it is not a package of mine, I let the author do it. For instance it will be

bower register codeicons git://github.com/mabrasil/codeicons.git

I just opened a pull request, let see what happens :).

You need to add few properties according to bower.json specification. Sometimes there are some doubts with the meaning, I will write here what I discover or how I use to fill them.

TODO fill keywords

author

main

homepage

keywords

Put some keywords you think can help to find your package in the bower search page.

moduleType

Usually I choose node. In this particular case I left it undefined.

license

Bonus tip: CDN

You can also add a CDN link for installation using RawGit.

Removing a package

If for some reason you want to remove a package from a registry… think twice. Anyway, you can do

curl -X DELETE "https://bower.herokuapp.com/packages/PACKAGE?access_token=TOKEN"

Where PACKAGE is the package name you want to delete and TOKEN is GitHub’s Personal Access Token that you can fetch from here: https://github.com/settings/applications See reference here.