Skip to content

Commit

Permalink
Renamed project 'wml'
Browse files Browse the repository at this point in the history
  • Loading branch information
dutzi committed Jun 12, 2016
1 parent 93b2f58 commit b559f57
Show file tree
Hide file tree
Showing 10 changed files with 33 additions and 33 deletions.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "wmlink",
"name": "wml",
"version": "0.0.0",
"description": "Replaces npm link with something that actually works!",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"bin": {
"wmlink": "./src/cli/wmlink-cli.js"
"wml": "./src/cli/wml-cli.js"
},
"author": "dutzi <[email protected]> (http://github.com/dutzi)",
"license": "ISC",
Expand Down
36 changes: 18 additions & 18 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# wmlink
# wml

> Use wmlink when symlinks simply aren't enough
> Use wml (watchman-link) when symlinks simply aren't enough
Wmlink listens to changes in some folder (using [watchman](https://facebook.github.io/watchman/)) and copies changed files to another folder.
Wml listens to changes in some folder (using [watchman](https://facebook.github.io/watchman/)) and copies changed files to another folder.

## Why?

Expand All @@ -11,58 +11,58 @@ todo
## Install

```sh
npm install -g wmlink
npm install -g wml
```

## Usage

```sh
# add the link to wmlink using `wmlink add <src> <dest>`
wmlink add ~/my-package ~/main-project/node_modules/my-package
# add the link to wml using `wml add <src> <dest>`
wml add ~/my-package ~/main-project/node_modules/my-package
# start watching all links added
wmlink start
wml start
```

### Commands
## Commands

#### add

`wmlink add <src> <dest>`
`wml add <src> <dest>`

Adds a link.
wmlink will not start listening to changes until you start it by running `wmlink start`.
Eace link is given an unique id, you can see all links and their ids by running `wmlink list`.
wml will not start listening to changes until you start it by running `wml start`.
Eace link is given an unique id, you can see all links and their ids by running `wml list`.

#### rm

`wmlink rm <linkId>`
`wml rm <linkId>`

Removes a link.

#### start

`wmlink start`
`wml start`

Starts wmlink.
Starts wml.

It first copies all watched files from source to destination folder and then waits for new changes to happen.

#### list

`wmlink list`
`wml list`

Lists all wmlink.
Lists all wml.
Shows link's id, state and source/destination folders.

#### enable

`wmlink enable <linkId>`
`wml enable <linkId>`

Enables a link.

#### disable

`wmlink disable <linkId>`
`wml disable <linkId>`

Disables a link.
Great for re-using old links without having to type them over and over again.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
13 changes: 13 additions & 0 deletions src/cli/wml-cli.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#!/usr/bin/env node
'use strict';

require('yargs')
.usage('$0 <cmd> [args]')
.command(require('./wml-cli-add.js'))
.command(require('./wml-cli-rm.js'))
.command(require('./wml-cli-start.js'))
.command(require('./wml-cli-list.js'))
.command(require('./wml-cli-enable.js'))
.command(require('./wml-cli-disable.js'))
.help('help')
.argv
13 changes: 0 additions & 13 deletions src/cli/wmlink-cli.js

This file was deleted.

0 comments on commit b559f57

Please sign in to comment.