LBRYCommunity/sudo-prompt
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Tweak readme

Browse source
This commit is contained in:
Joran Dirk Greef 2015-06-08 15:34:07 +02:00
parent 63b8c72173
commit 68baa7a7ed
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -1,13 +1,13 @@
# Sudo
Run a command using sudo, prompting the user with a gui OS dialog if necessary. Good for background applications or native Electron apps that need sudo.
Run a command using sudo, prompting the user with an OS dialog if necessary. Useful for background applications or native Electron apps that need sudo.
Currently supports native OS dialog prompt on Mac OS X (patches welcome for Linux) and uses process.title as the name of the app requesting permission.
Sudo has no external dependencies and does not contain any native bindings.
## Usage
Note that your command should not contain the sudo prefix.
Note: Your command should not start with the "sudo" prefix.
```
// To run a command using sudo:
var sudo = require('sudo-prompt');
@ -22,4 +22,4 @@ sudo.setName('Your app name')
```
## Concurrency
You can call Sudo.exec and Sudo.touch concurrently, Sudo will batch up permission requests into a single prompt.
You can call `sudo.exec` and `sudo.touch` concurrently, Sudo will batch up permission requests into a single prompt.