Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

initial commit

  • Loading branch information...
commit c1414680edc670ba90ed9f1ff7f7f2e6b1bcb134 1 parent e979ea6
@stefanjudis authored
View
1  .npmignore
@@ -0,0 +1 @@
+/node_modules/
View
22 LICENSE-MIT
@@ -0,0 +1,22 @@
+Copyright (c) 2012 stefan judis
+
+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 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.
View
29 README.md
@@ -1,2 +1,27 @@
-cushion-cli
-===========
+# cushion-cli
+
+Command line tool for cushion couchdb API.
+
+## Getting Started
+Install the module with: `npm install cushion-cli`
+
+```javascript
+var cushion_cli = require('cushion-cli');
+cushion_cli.awesome(); // "awesome"
+```
+
+## Documentation
+_(Coming soon)_
+
+## Examples
+_(Coming soon)_
+
+## Contributing
+In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](https://github.com/cowboy/grunt).
+
+## Release History
+_(Nothing yet)_
+
+## License
+Copyright (c) 2012 stefan judis
+Licensed under the MIT license.
View
39 grunt.js
@@ -0,0 +1,39 @@
+module.exports = function(grunt) {
+
+ // Project configuration.
+ grunt.initConfig({
+ pkg: '<json:package.json>',
+ test: {
+ files: ['test/**/*.js']
+ },
+ lint: {
+ files: ['grunt.js', 'lib/**/*.js', 'test/**/*.js']
+ },
+ watch: {
+ files: '<config:lint.files>',
+ tasks: 'default'
+ },
+ jshint: {
+ options: {
+ curly: true,
+ eqeqeq: true,
+ immed: true,
+ latedef: true,
+ newcap: true,
+ noarg: true,
+ sub: true,
+ undef: true,
+ boss: true,
+ eqnull: true,
+ node: true
+ },
+ globals: {
+ exports: true
+ }
+ }
+ });
+
+ // Default task.
+ grunt.registerTask('default', 'lint test');
+
+};
View
11 lib/cushion-cli.js
@@ -0,0 +1,11 @@
+/*
+ * cushion-cli
+ * https://github.com/stefanjudis/cushion-cli
+ *
+ * Copyright (c) 2012 stefan judis
+ * Licensed under the MIT license.
+ */
+
+exports.awesome = function() {
+ return 'awesome';
+};
View
35 package.json
@@ -0,0 +1,35 @@
+{
+ "name": "cushion-cli",
+ "description": "Command line tool for cushion couchdb API.",
+ "version": "0.1.0",
+ "homepage": "https://github.com/stefanjudis/cushion-cli",
+ "author": {
+ "name": "stefan judis",
+ "email": "stefanjudis@gmail.com",
+ "url": "www.stefanjudis.de"
+ },
+ "repository": {
+ "type": "git",
+ "url": "git://github.com/stefanjudis/cushion-cli.git"
+ },
+ "bugs": {
+ "url": "https://github.com/stefanjudis/cushion-cli/issues"
+ },
+ "licenses": [
+ {
+ "type": "MIT",
+ "url": "https://github.com/stefanjudis/cushion-cli/blob/master/LICENSE-MIT"
+ }
+ ],
+ "main": "lib/cushion-cli",
+ "engines": {
+ "node": ">= 0.6.0"
+ },
+ "scripts": {
+ "test": "grunt test"
+ },
+ "devDependencies": {
+ "grunt": "~0.3.15"
+ },
+ "keywords": []
+}
View
34 test/cushion-cli_test.js
@@ -0,0 +1,34 @@
+var cushion_cli = require('../lib/cushion-cli.js');
+
+/*
+ ======== A Handy Little Nodeunit Reference ========
+ https://github.com/caolan/nodeunit
+
+ Test methods:
+ test.expect(numAssertions)
+ test.done()
+ Test assertions:
+ test.ok(value, [message])
+ test.equal(actual, expected, [message])
+ test.notEqual(actual, expected, [message])
+ test.deepEqual(actual, expected, [message])
+ test.notDeepEqual(actual, expected, [message])
+ test.strictEqual(actual, expected, [message])
+ test.notStrictEqual(actual, expected, [message])
+ test.throws(block, [error], [message])
+ test.doesNotThrow(block, [error], [message])
+ test.ifError(value)
+*/
+
+exports['awesome'] = {
+ setUp: function(done) {
+ // setup here
+ done();
+ },
+ 'no args': function(test) {
+ test.expect(1);
+ // tests here
+ test.equal(cushion_cli.awesome(), 'awesome', 'should be awesome.');
+ test.done();
+ }
+};
Please sign in to comment.
Something went wrong with that request. Please try again.