Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updating demo page with new instructions

  • Loading branch information...
commit fadb1f00bfa9e473be8e6396a577ed033fec3c21 1 parent 9ace7b0
@bitpshr authored
View
2  src/holler.js → bin/holler
@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
//
// name : holler.js
// description : real-time, in-app notifications from the command line
View
2  src/holler-server.js → bin/holler-server
@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
//
// name : holler-server.js
// description : Starts a Faye server for notifications
View
0  demo/css/img/error.png 100644 → 100755
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
0  demo/css/img/log.png 100644 → 100755
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
0  demo/css/img/success.png 100644 → 100755
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
13 demo/index.html
@@ -34,10 +34,10 @@
<div class="container-narrow">
<h1 class="sectionTitle"><span class="accent">1.</span> Install a module</h1>
<p>
- Holler is built with <a href="http://nodejs.org/">Node</a>, uses <a href="http://faye.jcoglan.com/">Faye</a> for communication, and uses <a href="http://fabien-d.github.com/alertify.js/">Alertify</a> for notifications. If you don't have Node yet, <a href="http://nodejs.org/">install the hell out of it</a>. After doing so, the <code>npm</code> command should be available via the command line. Then we just install Faye:
+ Holler is built with <a href="http://nodejs.org/">Node</a> and is distributed as an <a href="http://npmjs.org">npm</a> module. If you don't have Node yet, <a href="http://nodejs.org/">install the hell out of it</a>. After doing so, the <code>npm</code> command should be available via the command line. Then we just install holler:
</p>
<p>
-<pre>npm install faye</pre>
+<pre>npm install holler</pre>
</p>
</div>
</div>
@@ -70,8 +70,7 @@ <h1 class="sectionTitle"><span class="accent">3.</span> Start a server</h1>
The server can be started with an optional port. If no port is specified, it will be defaulted to 1337.
</p>
<p>
-<pre>cd path/to/holler/src
-node holler-server.js 1337</pre>
+<pre>holler-server 1337</pre>
</p>
</div>
</div>
@@ -85,17 +84,17 @@ <h1 class="sectionTitle"><span class="accent">4.</span> Holler stuff</h1>
<p>
<h3>Log Messages</h3>
<img src="css/img/log.png" class="sample"/>
-<pre>node holler.js http://yourServerUrl:port log "This is a standard log message."</pre>
+<pre>holler http://yourServerUrl:port log "This is a standard log message."</pre>
</p>
<p>
<h3>Success Messages</h3>
<img src="css/img/success.png" class="sample"/>
-<pre>node holler.js http://yourServerUrl:port success "This is a success message."</pre>
+<pre>holler http://yourServerUrl:port success "This is a success message."</pre>
</p>
<p>
<h3>Error Messages</h3>
<img src="css/img/error.png" class="sample"/>
-<pre>node holler.js http://yourServerUrl:port error "This is an error message."</pre>
+<pre>holler http://yourServerUrl:port error "This is an error message."</pre>
</p>
<p>
<span class="label label-success">Try this!</span> Open up multiple browser windows all pointing to your test page. All windows should receive the notification in real-time.
View
0  dist/holler-client.concat.js 100644 → 100755
File mode changed
View
0  dist/holler-client.min.js 100644 → 100755
File mode changed
View
2  grunt.js
@@ -4,7 +4,7 @@ module.exports = function(grunt) {
grunt.initConfig({
pkg: grunt.file.readJSON('package.json'),
lint: {
- files: ['src/*.js']
+ files: ['src/*.js', 'bin/*.js']
},
concat: {
dist: {
View
37 package.json
@@ -1,8 +1,39 @@
{
"name": "holler",
+ "version": "1.0.5",
"author": "Paul Bouchon (@bitpshr)",
"description": "real-time, in-app notifications for web and mobile via the command line",
- "devDependencies": {
- "grunt-contrib-mincss": "~0.3.2"
- }
+ "homepage": "http://bitpshr.info/holler",
+ "keywords": [
+ "notifications",
+ "real-time",
+ "app",
+ "websockets",
+ "faye"
+ ],
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/bitpshr/holler"
+ },
+ "bugs": {
+ "email": "paulbouchon90@gmail.com",
+ "url": "http://github.com/bitpshr/holler/issues"
+ },
+ "dependencies": {
+ "faye" : "0.8.6"
+ },
+ "preferGlobal": "true",
+ "bin": {
+ "holler-server": "bin/holler-server",
+ "holler": "bin/holler"
+ },
+ "engines": {
+ "node": ">= 0.8.0"
+ },
+ "licenses": [
+ {
+ "type": "WTFPL",
+ "url": "http://sam.zoy.org/wtfpl/"
+ }
+ ]
}
View
0  src/alertify.js 100644 → 100755
File mode changed
Please sign in to comment.
Something went wrong with that request. Please try again.