Use tags instead of branches

[Tzahi12345]

I was wondering if it's possible to use a tag (e.g. v3.2) instead of using branches to receive files.

Thanks!

[doowb]

Hi @Tzahi12345 , yes, you can use a tag for the branch option. It's not obvious, so I tried it out and it worked correctly.

const options = {
  owner: 'doowb',
  repo: 'github-content',
  branch: '1.0.0' // 1.0.0 is a tag in this repository
};

const gc = new GithubContent(options);
gc.file('index.js', (err, file) => {
  if (err) return console.log(err);
  console.log(file.path);
  console.log(file.contents);
});

I'll leave this open with a docs label as a reminder to update the README with that information.

[Tzahi12345]

Awesome, thanks for the quick response!

[Tzahi12345]

Since you're updating the README anyways, I wanted to let you know something I noticed (it's really minor):

In the usage section it has the line var githubContent = require('github-content');, note the lack of capitalization on the first letter of the variable name.

Then in the example there's this line:

var gc = new GithubContent(options);, which uses a capital G in GithubContent.

Might clear up some confusion, took me a second to notice the discrepancy and fix it on my end. Anyways, that's all!