Skip to content

Commit 53f6dc0

Browse files
committed
More README improvements
1 parent 4b2e65b commit 53f6dc0

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,14 @@ try
4343
let info = await p4.awaitCommand('changelist.view', {changelist: changelist});
4444

4545
// edit changelist 1234
46-
let editResult = await p4.awaitCommand('changelist.edit', {changelist: 1234, description: 'Hello world'});
46+
let editResult = await p4.awaitCommand('changelist.edit', {changelist: 1234, description: 'Hi'});
4747

4848
// delete changelist 1234
4949
let deleteResult = await p4.awaitCommand('changelist.delete', {changelist: 1234});
5050

5151
// add files to changelist 1234
52-
let addResult = await p4.awaitCommand('add', {changelist: 1234, filetype: 'binary', files: ['*.bin']});
52+
let addResult = await p4.awaitCommand('add', {
53+
changelist: 1234, filetype: 'binary', files: ['*.bin']});
5354

5455
// check out files
5556
let editResult = await p4.awaitCommand('edit', {files: ['*.js']});
@@ -84,8 +85,8 @@ Unary options (no value needed) should simply have a value of true when you pass
8485
-t: {time: true}
8586
-u: {user: StringValue}
8687
'': {custom: StringValue} (any provided string will be appended to the initial command)
87-
{files: [StringValues]} (provided array of file paths as string values will be used for the command)
88-
{description: StringValue} (description will be inserted for the new or edited changelist using stdin)
88+
{files: [StringValues]} (provided array of file paths as strings will be used)
89+
{description: StringValue} (description is inserted for the new/edited changelist with stdin)
8990
```
9091

9192
## Debugging:
@@ -96,7 +97,7 @@ A debug option has been added to make it easier to see what commands are being r
9697
[P4 DEBUG] p4.exe edit -c 109 -t text //depot/MyFileName.json
9798
```
9899

99-
To use it, simply call `p4.setDebugMode(true)` after requiring the library. You will see debug info logged to console in this format:
100+
To use it, simply call `p4.setDebugMode(true)` after requiring the library:
100101

101102
```js
102103
var p4 = require('reckless-node-perforce');

0 commit comments

Comments
 (0)