# grunt-svn-tag

> Automate tagging svn working copies.

## Getting Started
This plugin requires Grunt `~0.4.0rc7`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-svn-tag --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-svn-tag');
```

## The "svn_tag" task

### Overview
This taks is not super flexible at the moment. It will always tag your current
working copy with the version listed in your project's `package.json` file using
the commit message:

```
admin: Tag for release (_version_)
```

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
_(Nothing yet)_

# grunt-svn-tag

> Automate tagging svn working copies.

## Getting Started
This plugin requires Grunt `~0.4.0rc7`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-svn-tag --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-svn-tag');
```

## The "svn_tag" task

### Overview
This taks is not super flexible at the moment. It will always tag your current
working copy path with the version listed in your project's `package.json` file
using the commit message:

```
admin: Tag for release (_version_)
```

The task must be run from your project's root folder and it must either be the
svn trunk or brunch (e.g. you cannot tag a tag or anything like that).

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
_(Nothing yet)_

Add note about only working from repo root
docs: Add note about only working from repo root

And requiring trunk or a branch
