filelink/README.md

Create file links.

filelink
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/okunishinishi/node-filelink
[bd_travis_url]: http://travis-ci.org/okunishinishi/node-filelink
[bd_travis_shield_url]: http://img.shields.io/travis/okunishinishi/node-filelink.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/okunishinishi/node-filelink
[bd_travis_com_shield_url]: https://api.travis-ci.com/okunishinishi/node-filelink.svg?token=
[bd_license_url]: https://github.com/okunishinishi/node-filelink/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-filelink
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-filelink.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-filelink.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/okunishinishi/node-filelink
[bd_gemnasium_shield_url]: https://gemnasium.com/okunishinishi/node-filelink.svg
[bd_npm_url]: http://www.npmjs.org/package/filelink
[bd_npm_shield_url]: http://img.shields.io/npm/v/filelink.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Create file links.

<!-- Description End -->




<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install filelink --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

Create a relative symlink.

```javascript
'use strict'

const filelink = require('filelink')

filelink('src/foo.js', 'dest/foo-link.js', {
  force: true
}).then(() => {
  /* ... */
});
```




<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Options.md.hbs" Start -->

<a name="section-doc-guides-03-options-md"></a>

Options
-------

| Key | Description | Default |
| --- | ---- | --- |
| type | Type of link. "symlink" or "link" | "symlink" |
| force | Force to create link. | false |
| mkdirp | Create parent directories. | false |

<!-- Section from "doc/guides/03.Options.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/okunishinishi/node-filelink/blob/master/LICENSE).

<!-- LICENSE End -->