Permalink
Browse files

Merged contributing to readme

  • Loading branch information...
1 parent 1bd01cd commit 771c99ba09216fadec88389813e6144526ff3547 @tefra committed Jul 10, 2013
Showing with 29 additions and 26 deletions.
  1. +0 −25 CONTRIBUTING.md
  2. +29 −1 README.md
View
@@ -1,25 +0,0 @@
-# Contributing
-
-### Code style
-Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.**
-
-## Modifying the code
-First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.
-
-Test that Grunt's CLI is installed by running `grunt --version`. If the command isn't found, run `npm install -g grunt-cli`. For more information about installing Grunt, see the [getting started guide](http://gruntjs.com/getting-started).
-
-1. Fork and clone the repo.
-1. Run `npm install` to install all dependencies (including Grunt).
-1. Run `grunt` to grunt this project.
-
-Assuming that you don't see any red, you're ready to go. Just be sure to run `grunt` after making any changes, to ensure that nothing is broken.
-
-## Submitting pull requests
-
-1. Create a new branch, please don't work in your `master` branch directly.
-1. Add failing tests for the change you want to make. Run `grunt` to see the tests fail.
-1. Fix stuff.
-1. Run `grunt` to see if the tests pass. Repeat steps 2-4 until done.
-1. Open `test/*.html` unit test file(s) in actual browser to ensure tests pass everywhere.
-1. Update the documentation to reflect any changes.
-1. Push to your fork and submit a pull request.
View
@@ -6,7 +6,9 @@
Navgoco is a simple JQuery plugin which turns a nested unordered list of links
into a beautiful vertical multi-level slide navigation, with ability to preserve
expanded sub-menus between sessions by using cookies and optionally act as an accordion
-menu. **[Demo](http://apps.komposta.net/jquery/navgoco/demo)**
+menu.
+
+**[Demo](http://apps.komposta.net/jquery/navgoco/demo)** | **[Homepage](http://www.komposta.net/article/navgoco)**
## Getting Started
Download the plugin, unzip it and copy the files to your application directory and load them inside your HTML.
@@ -159,3 +161,29 @@ Destroy instances and unbind events.
// I can't think of any other use except for testing...
$(selector).navgoco('destroy');
```
+
+## Contributing
+
+#### Code style
+Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.**
+
+#### Modifying the code
+First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.
+
+Test that Grunt's CLI is installed by running `grunt --version`. If the command isn't found, run `npm install -g grunt-cli`. For more information about installing Grunt, see the [getting started guide](http://gruntjs.com/getting-started).
+
+1. Fork and clone the repo.
+1. Run `npm install` to install all dependencies (including Grunt).
+1. Run `grunt` to grunt this project.
+
+Assuming that you don't see any red, you're ready to go. Just be sure to run `grunt` after making any changes, to ensure that nothing is broken.
+
+#### Submitting pull requests
+
+1. Create a new branch, please don't work in your `master` branch directly.
+1. Add failing tests for the change you want to make. Run `grunt` to see the tests fail.
+1. Fix stuff.
+1. Run `grunt` to see if the tests pass. Repeat steps 2-4 until done.
+1. Open `test/*.html` unit test file(s) in actual browser to ensure tests pass everywhere.
+1. Update the documentation to reflect any changes.
+1. Push to your fork and submit a pull request.

0 comments on commit 771c99b

Please sign in to comment.