backup
Advanced tools
Comparing version 1.0.0-2 to 1.0.0-3
{ | ||
"name": "backup", | ||
"version": "1.0.0-2", | ||
"version": "1.0.0-3", | ||
"description": "Web Site backup & restore", | ||
@@ -5,0 +5,0 @@ "main": "./index.js", |
@@ -1,7 +0,56 @@ | ||
node backup | ||
=========== | ||
node.js Backup & Restore | ||
======================== | ||
> IN DEVELOPMENT | ||
Easy Backup & Restore web site project. All files and directories are written to one file (and files are compressed via GZIP). | ||
- backup file is text file | ||
- supports backup and restore: files and directories | ||
- simple filtering files and directories | ||
- simple structure | ||
- easy manipulation | ||
- easy use in your project | ||
- executables *backup* and *restore* from terminal | ||
## node.js | ||
```js | ||
var backup = require('backup'); | ||
/* | ||
Backup directory to file | ||
@directory {String} | ||
@filename {String}, | ||
@complete {Function} :: optional | ||
@filter {Function} :: optional, param @path {String} return TRUE | FALSE, if FALSE file or directory will skipped | ||
*/ | ||
backup.backup('/path/to/directory/', '/users/petersirka/desktop/website.backup'); | ||
/* | ||
Restore from file | ||
@filename {String}, | ||
@directory {String} | ||
@complete {Function} :: optional | ||
@filter {Function} :: optional, param @path {String} return TRUE | FALSE, if FALSE file or directory will skipped | ||
*/ | ||
backup.restore('/users/petersirka/desktop/website.backup', '/path/to/directory/'); | ||
``` | ||
## BINARY | ||
``` | ||
// backup current directory | ||
// $ backup @filename | ||
$ backup /users/petersirka/desktop/website.backup | ||
// restore backup file | ||
// $ restore @filename @path | ||
$ restore /users/petersirka/desktop/website.backup /users/petersirka/desktop/ | ||
``` | ||
## The MIT License | ||
@@ -8,0 +57,0 @@ |
10633
68