README.md in network_executive-0.0.1.alpha.1 vs README.md in network_executive-0.0.2
- old
+ new
@@ -1,8 +1,8 @@
# Network Executive
-An experimental application used to drive displays hung around an office.
+An experimental Rails engine used to drive displays hung around an office.
## Installation
Add this line to your application's Gemfile:
@@ -14,17 +14,14 @@
Or install it yourself as:
$ gem install network_executive
-Create a new Network:
+Run the installation script:
- $ net_exec new [YOUR_NETWORK_NAME]
+ $ rails g network_executive:install
-This will create a new directory that matches your network name and populate it
-with an application scaffold.
-
All that's left is to start building your network!
## Usage
$ net_exec server
@@ -55,45 +52,10 @@
Clearing an EAS will be made by accessing `/all_clear`. Doing so will return the viewer to regularly scheduled programming.
If multiple EAS' are active, the correct EAS will be cleared.
-## Channel Line-up
-
- A JSON file that defines the various Programs (URLs to visit) and then they should be delivered.
-
- // In `channels/my_channel_name.json`
- {
- name : 'My Channel Name', // Examples: Marketing, Sales, Technology, etc. Be creative!
- url : '/my_channel_name', // Optional. Automatically inferred from the Channel Name
- logo : '/logos/my_channel_logo.png, // Optional. Automatically inferred from the Channel Name. Defaults to `nil`
- ticker : 'host.com/my_ticker_feed.xml', // Optional. Specifying a URL will add a new ticker to the bottom for the screen with the feed's data
- on_air : '6am'
- line_up : [
- {
- url : 'http://www.cnn.com',
- airs : '30 * * * *' // Every 30 minutes (from https://github.com/ncb000gt/node-cron,
- // https://github.com/mattpat/node-schedule and http://www.openjs.com/scripts/jslibrary/demos/crontab.php)
- runtime : '30min', // How do runtimes affect air times?
- commercial_free : true, // Optional. Disables any commericals. Defaults to FALSE.
- username : 'my_username', // Optional. Necessary for Basic Auth ?
- password : 'my_password' // Optional. Necessary for Basic Auth ?
- },{
- url : 'http://www.flickr.com/photos/USER/sets/1234/show/',
- airs : '60 * * * *'
- }
- ],
- commercials : [
- '/spot_1', // Local ad. Inherits all defaults.
- {
- url : 'http://example.com/spot_2', // Remote ad.
- airs : '9am to 10am' // Air only in the morning.
- runtime : '15s' // Optional. `Xs`, `Xm`, or `Xh` where `X` is an integer. Defaults to 30 seconds.
- }
- ]
- }
-
## Commercials
Commercials provide a fun and interesting way to break up the monotony of viewing analytics data all day. Be creative!
The scheduling of commercials is determined by how many commercials are defined and long each program runs for. By default,
@@ -122,9 +84,15 @@
* _Network Logo_ - Useful?
* _Commericals / PSAs_ - The More You Know?
* _Viewer_ - The client-side component. SSEs?
* _Clicker_ - Client-side slide out remote to change channels/networks?
* _On-Demand_ - Change to and stay at a specific channel. "Live" to exit.* _On-Demand_ - Change to and stay at a specific channel. "Live" to exit.1
+
+## TODO
+
+* Raise an exception if there are no channels to ease bootstrapping for new users
+* Swap out jQuery for Zepto?
+* Add http://brad.is/coding/BigScreen/
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)