improve Readme
This commit is contained in:
parent
044004701b
commit
711a5d0667
21
README.md
21
README.md
@ -1,20 +1,33 @@
|
||||
# smartssh
|
||||
setups SSH quickly and in a painless manner
|
||||
|
||||
> Attention: This is still alpha, so some things won't work
|
||||
> Attention: This is still alpha, so some things won't work, not all things are inplemented.
|
||||
I (Phil from Lossless) expect this to be ready 2016/05/01.
|
||||
|
||||
## Usage
|
||||
|
||||
```javascript
|
||||
var smartssh = require("smartssh");
|
||||
var sshInstance = new smartssh({
|
||||
var sshInstance = new smartssh.sshInstance({
|
||||
sshDir: "/some/path/.ssh", // the standard ssh directory, optional, defaults to "~./.ssh"
|
||||
sshSync: true // sync ssh this instance will represent the status of an ssh dir if set to true;
|
||||
});
|
||||
|
||||
sshInstance.addKey({
|
||||
sshInstance.addKey(new smartssh.sshKey({
|
||||
private: "somestring",
|
||||
public: "somestring"
|
||||
public: "somestring", // optional
|
||||
for:"github.com",
|
||||
encoding: "base64" // optional, defaults to "utf8", can be "utf8" or "base64", useful for reading ssh keys from environment variables
|
||||
}));
|
||||
|
||||
sshInstance.createKey({
|
||||
for:"gitlab.com" // returns new key in the form sshKey, read more about the sshKey class below
|
||||
})
|
||||
|
||||
sshInstance.getKey({ // returns ssh key in the form sshKey, read more about the sshKey class below
|
||||
for:"github.com"
|
||||
});
|
||||
|
||||
sshInstance.getKeys() // returns array of all available getKeys. Each key is in form of class sshKey
|
||||
|
||||
```
|
Loading…
Reference in New Issue
Block a user