# Ctags Node module [![Build Status](https://travis-ci.org/atom/node-ctags.png)](https://travis-ci.org/atom/node-ctags)

Read all about ctags [here](http://ctags.sourceforge.net/).

## Installing

```sh
npm install ctags
```

## Documentation

### findTag(path, tag)

Get all tags matching the tag specified from the tags file at the path.

```coffeescript
ctags = require 'ctags'

tags = ctags.findTag('/Users/me/repos/node/tags', 'exists')
```

### getTags(path)

Get all tags found in the path specified.

```coffeescript
ctags = require 'ctags'

allTags = ctags.getTags('/Users/me/repos/node/tags')
```

# Ctags Node module [![Build Status](https://travis-ci.org/atom/node-ctags.png)](https://travis-ci.org/atom/node-ctags)

Read all about ctags [here](http://ctags.sourceforge.net/).

## Installing

```sh
npm install ctags
```

## Documentation

### findTag(path, tag)

Get all tags matching the tag specified from the tags file at the path.

```coffeescript
ctags = require 'ctags'

tags = ctags.findTag('/Users/me/repos/node/tags', 'exists')
for tag in tags
  console.log("#{tag.name} is in #{tag.file}")
```

### getTags(path)

Get all tags found in the path specified.

```coffeescript
ctags = require 'ctags'

allTags = ctags.getTags('/Users/me/repos/node/tags')
for tag in allTags
  console.log("#{tag.name} is in #{tag.file} with pattern: #{tag.pattern}")
```

Add example of fields in tag objects
Add example of fields in tag objects
