UNPKG

1.33 kBMarkdownView Raw
1# antfarm
2
3Antfarm is a simple automation framework that aims to make file automation robust and scalable. 🐜
4
5[![Build Status](https://travis-ci.org/dominickp/antfarm.svg?branch=master)](https://travis-ci.org/dominickp/antfarm)
6[![Coverage Status](https://coveralls.io/repos/github/dominickp/antfarm/badge.svg?branch=master)](https://coveralls.io/github/dominickp/antfarm?branch=master)
7[![npm version](https://badge.fury.io/js/antfarm.svg)](https://badge.fury.io/js/antfarm)
8[![Dependancy Status](https://david-dm.org/dominickp/antfarm.svg)](https://david-dm.org/dominickp/antfarm)
9[![Gitter](https://badges.gitter.im/dominickp/antfarm.svg)](https://gitter.im/open-automation/Lobby)
10
11## Usage
12
13```sh
14$ npm install antfarm
15```
16
17```js
18var Antfarm = require('antfarm'),
19 af = new Antfarm();
20
21var hotfolder_a = af.createFolderNest("/var/hotfolders/a");
22var pdf_folder = af.createFolderNest("/var/out/pdf");
23var other_folder = af.createFolderNest("/var/out/others");
24
25var tunnel = af.createTunnel("Simple pdf sorting workflow");
26
27tunnel.watch(hotfolder_a);
28
29tunnel.run(function(job, nest){
30 if(job.getExtension() == "pdf"){
31 job.move(pdf_folder);
32 } else {
33 job.move(other_folder);
34 }
35});
36
37```
38
39## Wiki
40https://github.com/dominickp/antfarm/wiki
41
42## API Reference
43https://dominickp.github.io/antfarm