Documentation: Example?

[cepm-nate]

I was wondering if you could put a 'Usage' example in the main readme? In my Ionic 2 project I've put the 'secure-ftp-master' folder into the 'node_modules' folder. Then in my app.module.ts added import { FTP } from 'secure-ftp-master';, and added FTP to the providers array. Then in my module, I used the same import statement, and also include private ftp: FTP in the construtor.

But when I compile the app it complains that "Can't resolve all parameters", and shows a "?" referring to the private ftp: FTP argument in the constructor.

These same steps are what I've done for many other libraries, and I'm wondering if this is how someone would use your library, or if something different is needed.

Thanks!

[benbabic]

Happy to see some interest in the library, I will add some docs tonight along with a couple of updates I have not pushed yet

[cepm-nate]

Fantastic! I look forward to whenever you get it up. For now I've put together a little node.js POST server to accept the files and drop them in place, but would honestly rather use ftp as it's a lot less complicated. :-)

[benbabic]

Hey @cepm-nate I've just updated the library and put some quick docs together, let me know if you run into any issues