You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Nathan Smith 46a861c3a1 structure -- moved src from node project to main project. 12 years ago
..
lib Fixes issue with accidental submodule 12 years ago
test Fixes issue with accidental submodule 12 years ago
.npmignore Fixes issue with accidental submodule 12 years ago
README.md Fixes issue with accidental submodule 12 years ago
grunt.js Fixes issue with accidental submodule 12 years ago

README.md

{%= name %}

{%= description %}

Getting Started

On the server

Install the module with: npm install {%= name %}

var {%= js_safe_name %} = require('{%= name %}');
{%= js_safe_name %}.awesome(); // "awesome"

In the browser

Download the [production version][min] or the [development version][max].

[min]: https://raw.github.com/{%= git_user %}/{%= git_repo %}/master/dist/{%= name %}.min.js [max]: https://raw.github.com/{%= git_user %}/{%= git_repo %}/master/dist/{%= name %}.js

In your web page:

<script src="dist/{%= name %}.min.js"></script>
<script>
awesome(); // "awesome"
</script>

In your code, you can attach {%= name %}'s methods to any object.

<script>
this.exports = Bocoup.utils;
</script>
<script src="dist/{%= name %}.min.js"></script>
<script>
Bocoup.utils.awesome(); // "awesome"
</script>

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.

Also, please don't edit files in the "dist" subdirectory as they are generated via grunt. You'll find source code in the "lib" subdirectory!

Release History

(Nothing yet)

License

Copyright (c) {%= grunt.template.today('yyyy') %} {%= author_name %}
Licensed under the {%= licenses.join(', ') %} license{%= licenses.length === 1 ? '' : 's' %}.