Update example and add wiki link

This commit is contained in:
Yannick Croissant
2013-07-31 00:45:23 +02:00
parent 57d482adeb
commit caf5477304

View File

@ -19,21 +19,26 @@ var syno = new Synology({
password: 'mypassword'
});
syno.query('/webapi/query.cgi', {
api : 'SYNO.API.Info',
version: 1,
method : 'query',
query : 'ALL'
syno.fileStation.upload({
file: fs.createReadStream(path.join(__dirname, 'foo.txt')),
dest_folder_path: '/home'
}, function(err, data) {
if (err) throw err;
console.log(data);
if (err) throw err;
console.log(data);
});
```
API documentation can be found on the [Wiki](https://github.com/yannickcr/node-synology/wiki)
It's a pretty big (non-documented) API and I need to reverse every methods and guess the parameters, document it then do a usable wrapper.
Not very difficult for the majority of the methods but really time consuming. Help is welcome ;)
For now you can still use directly the Synology.query method to do a raw query but it is not very user friendly.
# TODO
* Documentation
* Documentation (In progress)
* Helpers (In progress)
* Tests
* Helpers
# License