Updating readme

jdalrymple · Jan 30, 2017 · a99d7f0 · a99d7f0
1 parent 257eef2
commit a99d7f0
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -49,7 +49,8 @@ repo.push()
 ```javascript
 const Hg = require('hg-plus');
 
-let combinedRepo = Hg.clone(['my/repository/url1', 'my/repository/url2', 'my/repository/url3']);
+let to = {url:'another/url',username:'user2',password:'pass2',path:'path2'};
+let combinedRepo = Hg.clone(['my/repository/url1', 'my/repository/url2', 'my/repository/url3'], to);
 
 combinedRepo.commit('I just created a repository from three other repositories!'))
 .then(() => repo.push({password: 'myPassword',username:'username'}))
@@ -111,12 +112,12 @@ Clones a Mercurial repository.
 
 | Argument      | Description           | Type     | Required | Default           |
 |---------------|-----------------------|----------|----------|-------------------|
-| from          |                       | String   | Yes      |                   |
-| to            |                       | Object   | No       |                   |
+| from          |                       | String OR Array<String>   | Yes  |      |
+| to            |                       | Object   | Yes when cloning from many origins, No otherwise       |                   |
 | to.url        |                       | String   | No       | null              |
 | to.username   |                       | String   | No       | null              |
 | to.password   |                       | String   | No       | null              |
-| to.path       |                       | String   | No       | Current Directory |
+| to.path       |                       | String   | No       | Current Directory/<Cloned repo name> |
 | done          | Callback function     | Function | No       | null              |
 
 | Returns                | Description      |