#Ducky-Stream Ducky is a live coding and file streaming website for software engineers to work collaborativly on projects and code, all in real time. Ducky lets users live stream video, as well as a project directory. For more information on Ducky please see https://github.com/MattHsiung/ducky_build and visit us at www.duckystream.tv.

ducky-stream is the node module for live streaming project files to a Ducky channel. This module allows streamers to share live file updates to their channel page on the Ducky website.

NPM https://www.npmjs.com/package/ducky-stream Github https://github.com/jmeeke02/ducky-stream

##Requirements:

1. To use the ducky-stream module, you will need an account with Ducky. If you have not already done so, please go to www.duckystream.tv/signup to create an account with Ducky.
2. Your project needs a .gitignore file to run ducky-stream. Ducky will not share any files you have in

##Installation

1. Run npm install -g ducky-stream, to globally install the ducky-stream module.
2. In your command line tool, cd into the project you want to stream.
3. Run ducky login and enter your credentials (username and password) when prompted.
4. The ducky module will provide you with a secret key that you can use to stream, as well as the url for your specific streaming channel.
5. In streaming video application like OBS:
   • Open the stream settings and set the following.
   • Stream Type: Custom Streaming Server
   • Stream Url: rtmp://www.duckystream.tv/live
   • Stream key: your secret key
6. Run ducky stream from the directory you want to share to begin streaming your file system.

##Usage

Ducky uses file system watchers to share your project files with viewers of your channel. Upon initially running "ducky stream" you will see the ducky-stream module sync up each file in your current project. Any file you have gitignored will not be shared. Any subsequent changes to your files and folders, including adding and deleting files will be synced with your channel and update in real time upon saving these changes

When you are finished streaming, Ducky will remove any files you have shared, from your channel. Files are only synced when your channel is live. Ducky does not store your files after you've closed your stream.

Note: Ducky will not share any files that you have included in your .gitignore. You must have a gitignore in the current directory, for you to stream your files.

###Contributing and Credits Jordan Meeker & Matt Hsiung & Sean Colandrea & Franklin Lee

Don't forget to go to www.duckystream.tv to stream your video.

Thanks, the ducky team