v1.1.0. Now pre-compiles our coffee-script.

bevry · May 4, 2012 · db29f7e · db29f7e
1 parent f0f33ae
commit db29f7e
Show file tree

Hide file tree

Showing 22 changed files with 599 additions and 114 deletions.
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,8 @@
+.DS_Store
+.git*
+.travis*
+*.md
+Makefile
+docs/
+example/
+src/
diff --git a/History.md b/History.md
@@ -1,6 +1,9 @@
 ## History
 
-- v1.0 February 11, 2012
+- v1.1.0 May 4, 2012
+	- Caterpillar now pre-compiles, so the coffee-script dependency is no longer needed
+
+- v1.0.0 February 11, 2012
 	- Modularised
 	- Added [docco](http://jashkenas.github.com/docco/) docs
 	- Debug line is now only outputted if the log level is 7

diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,6 +1,7 @@
 (The MIT License)
 
-Copyright (c) 2011-2012 Benjamin Lupton <b@lupton.cc>
+Copyright (c) 2012 Bevry Pty Ltd <us@bevry.me>
+Copyright (c) 2011 Benjamin Lupton <b@lupton.cc>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

diff --git a/Makefile b/Makefile
@@ -1,24 +1,17 @@
-test:
+dev:
-	./node_modules/.bin/mocha \
+	./node_modules/.bin/coffee -w -o lib/ -c src/
-		--reporter spec \
-		--ui bdd \
-		--ignore-leaks \
-		--growl
-
-test-debug:
-	node --debug-brk ./node_modules/.bin/mocha \
-		--reporter spec \
-		--ui bdd \
-		--ignore-leaks \
-		--growl
 
 docs:
-	./node_modules/.bin/docco lib/*.coffee
+	./node_modules/.bin/docco src/*.coffee
 
 example:
-	coffee ./examples/console.coffee
+	./node_modules/.bin/coffee ./example/console.coffee
 
 example-debug:
-	coffee ./examples/console.coffee -d
+	./node_modules/.bin/coffee ./example/console.coffee -d
+
+clean:
+	rm -Rf node_modules/ npm-debug.log
+	npm install
 
-.PHONY: test
+.PHONY: dev docs example example-debug clean
diff --git a/README.md b/README.md
@@ -30,15 +30,23 @@ Please refer to the [console example](https://github.com/bevry/caterpillar/blob/
 
 1. [Install Node.js](https://github.com/balupton/node/wiki/Installing-Node.js)
 
-1. Install [CoffeeScript](http://jashkenas.github.com/coffee-script/)
-
-		npm -g install coffee-script
-
 1. Install Caterpillar
 
 		npm install caterpillar
 
 
+## History
+
+You can discover the history inside the [History.md](https://github.com/bevry/caterpillar/blob/master/History.md#files) file
+
+
+## License
+
+Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://creativecommons.org/licenses/MIT/)
+<br/>Copyright &copy; 2012 [Bevry Pty Ltd](http://bevry.me)
+<br/>Copyright &copy; 2011 [Benjamin Lupton](http://balupton.com)
+
+
 ## Thanks
 
 Uses the following:
@@ -52,9 +60,3 @@ Inspired by the following:
 - [TJ Holowaychuk's](https://github.com/visionmedia) [Log.js](https://github.com/visionmedia/log.js)
 - [Igor Urminček's](https://github.com/igo) [NLogger](https://github.com/igo/nlogger)
 - [SchizoDuckie's](https://github.com/SchizoDuckie) [Node-CLI](https://github.com/SchizoDuckie/Node-CLI/)
-
-
-## License
-
-Licensed under the [MIT License](http://creativecommons.org/licenses/MIT/)
-<br/>Copyright &copy; 2011-2012 [Benjamin Arthur Lupton](http://balupton.com)
diff --git a/docs/caterpillar.html b/docs/caterpillar.html
@@ -1,6 +1,6 @@
-<!DOCTYPE html>  <html> <head>   <title>caterpillar.coffee</title>   <meta http-equiv="content-type" content="text/html; charset=UTF-8">   <link rel="stylesheet" media="all" href="docco.css" /> </head> <body>   <div id="container">     <div id="background"></div>            <div id="jump_to">         Jump To &hellip;         <div id="jump_wrapper">           <div id="jump_page">                                           <a class="source" href="caterpillar.html">                 caterpillar.coffee               </a>                                           <a class="source" href="formatter.html">                 formatter.coffee               </a>                                           <a class="source" href="logger.html">                 logger.coffee               </a>                                           <a class="source" href="transport.html">                 transport.coffee               </a>                        </div>         </div>       </div>          <table cellpadding="0" cellspacing="0">       <thead>         <tr>           <th class="docs">             <h1>               caterpillar.coffee             </h1>           </th>           <th class="code">           </th>         </tr>       </thead>       <tbody>                               <tr id="section-1">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-1">&#182;</a>               </div>               <p>Requires</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="p">{</span><span class="nx">cliColor</span><span class="p">,</span><span class="nx">Formatter</span><span class="p">,</span><span class="nx">ConsoleFormatter</span><span class="p">}</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s2">&quot;#{__dirname}/formatter.coffee&quot;</span><span class="p">)</span>
+<!DOCTYPE html>  <html> <head>   <title>caterpillar.coffee</title>   <meta http-equiv="content-type" content="text/html; charset=UTF-8">   <link rel="stylesheet" media="all" href="docco.css" /> </head> <body>   <div id="container">     <div id="background"></div>            <div id="jump_to">         Jump To &hellip;         <div id="jump_wrapper">           <div id="jump_page">                                           <a class="source" href="caterpillar.html">                 caterpillar.coffee               </a>                                           <a class="source" href="formatter.html">                 formatter.coffee               </a>                                           <a class="source" href="logger.html">                 logger.coffee               </a>                                           <a class="source" href="transport.html">                 transport.coffee               </a>                        </div>         </div>       </div>          <table cellpadding="0" cellspacing="0">       <thead>         <tr>           <th class="docs">             <h1>               caterpillar.coffee             </h1>           </th>           <th class="code">           </th>         </tr>       </thead>       <tbody>                               <tr id="section-1">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-1">&#182;</a>               </div>               <p>Requires</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="p">{</span><span class="nx">cliColor</span><span class="p">,</span><span class="nx">Formatter</span><span class="p">,</span><span class="nx">ConsoleFormatter</span><span class="p">}</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s2">&quot;#{__dirname}/formatter&quot;</span><span class="p">)</span>
-<span class="p">{</span><span class="nx">Logger</span><span class="p">}</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s2">&quot;#{__dirname}/logger.coffee&quot;</span><span class="p">)</span>
+<span class="p">{</span><span class="nx">Logger</span><span class="p">}</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s2">&quot;#{__dirname}/logger&quot;</span><span class="p">)</span>
-<span class="p">{</span><span class="nx">Transport</span><span class="p">,</span><span class="nx">ConsoleTransport</span><span class="p">}</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s2">&quot;#{__dirname}/transport.coffee&quot;</span><span class="p">)</span></pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <p>Export</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="nv">module.exports = </span><span class="p">{</span>
+<span class="p">{</span><span class="nx">Transport</span><span class="p">,</span><span class="nx">ConsoleTransport</span><span class="p">}</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s2">&quot;#{__dirname}/transport&quot;</span><span class="p">)</span></pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <p>Export</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="nv">module.exports = </span><span class="p">{</span>
 	<span class="nx">cliColor</span><span class="p">,</span>
 	<span class="nx">Formatter</span><span class="p">,</span>
 	<span class="nx">ConsoleFormatter</span><span class="p">,</span>

diff --git a/docs/docco.css b/docs/docco.css
diff --git a/docs/formatter.html b/docs/formatter.html