Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
jhamlet committed Jun 1, 2013
0 parents commit 07b3ab8
Show file tree
Hide file tree
Showing 10 changed files with 228 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
@@ -0,0 +1,4 @@
.DS_Store
npm-debug.log
/node_modules/*
!/node_modules/eligo
4 changes: 4 additions & 0 deletions .npmignore
@@ -0,0 +1,4 @@
.DS_Store
Sakefile*
src
test
1 change: 1 addition & 0 deletions AUTHORS
@@ -0,0 +1 @@
Jerry Hamlet <jerry@hamletink.com> (http://hamletink.com/)
24 changes: 24 additions & 0 deletions LICENSE
@@ -0,0 +1,24 @@
Copyright (c) 2013 Jerry Hamlet <jerry@hamletink.com>

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:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

The Software shall be used for Good, not Evil.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
73 changes: 73 additions & 0 deletions README.md
@@ -0,0 +1,73 @@
Eligo
=====

>

Summary
-------


Installation
------------

~~~
% npm install eligo
~~~


### Dependencies ###

These are installed when **eligo** is installed.

~~~
ambulo: 0.1.x
~~~


### Development Dependencies ###

Installed when you run `npm link` in the package directory.

~~~
mocha: 1.7.x
should: 1.2.x
sake: 0.1.x
ejs: 0.8.x
~~~


Report an Issue
---------------

* [Bugs](http://github.com/jhamlet/node-eligo/issues)
* Contact the author: <jerry@hamletink.com>


License
-------

> Copyright (c) 2013 Jerry Hamlet <jerry@hamletink.com>
>
> 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:
>
> The above copyright notice and this permission notice shall be
> included in all copies or substantial portions of the Software.
>
> The Software shall be used for Good, not Evil.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
> OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
> HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
> WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
> FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
> OTHER DEALINGS IN THE SOFTWARE.
27 changes: 27 additions & 0 deletions Sakefile
@@ -0,0 +1,27 @@
/*globals FileList, CLEAN, CLOBBER, desc, task, directory, write, fileSync, log, sh, read */

require('sake/clobber');

desc('Generate the README.md documentation');
fileSync(
'README.md',
['src/tmpl/README.ejs', 'package.json', 'Sakefile'],
function (t) {
var ejs = require('ejs'),
pkgInfo = JSON.parse(read('package.json', 'utf8')),
tmpl = ejs.compile(read(t.prerequisites[0], 'utf8')),
tmplParams = {
pkg: pkgInfo,
license: read('./LICENSE', 'utf8')
}
;

write(t.name, tmpl(tmplParams), 'utf8');
log.info(t.name + ' generated');
}
);

CLEAN.include('README.md');

task('build', ['README.md']);
task('default', ['build']);
Empty file added node_modules/eligo/index.js
Empty file.
32 changes: 32 additions & 0 deletions package.json
@@ -0,0 +1,32 @@
{
"name": "eligo",
"description": "",
"version": "0.0.0",
"keywords": [],
"main": "./node_modules/eligo/index.js",
"dependencies": {
"ambulo": "0.1.x"
},
"devDependencies": {
"mocha": "1.7.x",
"should": "1.2.x",
"sake": "0.1.x",
"ejs": "0.8.x"
},
"bundledDependencies": [
"eligo"
],
"licenses": [
{
"type": "MIT",
"url": "http://github.com/jhamlet/node-eligo/raw/master/LICENSE"
}
],
"repository": {
"type": "git",
"url": "http://github.com/jhamlet/node-eligo.git"
},
"bugs": {
"url": "http://github.com/jhamlet/node-eligo/issues"
}
}
61 changes: 61 additions & 0 deletions src/tmpl/README.ejs
@@ -0,0 +1,61 @@
<%- scriptName = pkg.name[0].toUpperCase() + pkg.name.slice(1) %>
<%- Array(scriptName.length+1).join("=") %>

> <%-pkg.description%>


Summary
-------


Installation
------------

~~~
% npm install <%-pkg.name%>
~~~


### Dependencies ###

These are installed when **<%-pkg.name%>** is installed.
<% var fw = Object.keys(pkg.dependencies).reduce(function (t, c) {
var len = c.length;
return len > t ? len : t;
}, 0),
deps = Object.keys(pkg.dependencies).map(function (key) {
var pad = Array(fw - key.length + 1).join(" ");
return key + ": " + pad + pkg.dependencies[key];
}).join("\n");%>
~~~
<%-deps%>
~~~


### Development Dependencies ###

Installed when you run `npm link` in the package directory.
<% var fw = Object.keys(pkg.devDependencies).reduce(function (t, c) {
var len = c.length;
return len > t ? len : t;
}, 0),
devDeps = Object.keys(pkg.devDependencies).map(function (key) {
var pad = Array(fw - key.length + 1).join(" ");
return key + ": " + pad + pkg.devDependencies[key];
}).join("\n");%>
~~~
<%-devDeps%>
~~~


Report an Issue
---------------

* [Bugs](<%-pkg.bugs.url%>)
* Contact the author: <jerry@hamletink.com>


License
-------

<%-license.split("\n").map(function (line) { return "> " + line; }).join("\n")%>
2 changes: 2 additions & 0 deletions test/mocha.opts
@@ -0,0 +1,2 @@
--require should
--reporter spec

0 comments on commit 07b3ab8

Please sign in to comment.