Merge pull request #29 from neocotic/wip-3.0.0

WIP 3.0.0

AUTHORS.md

@@ -2,3 +2,4 @@
 
 * Trevor Jim <[email protected]>
 * Alasdair Mercer <[email protected]>
+* Tim Chaplin <[email protected]>

CHANGES.md

@@ -1,8 +1,14 @@
-2013.05.06, Version 2.1.1
+## Version 3.0.0, 2013.08.15
+
+* [#30](https://github.com/neocotic/html.md/issues/30): Rename command from `md` to `html-md`
+* [#31](https://github.com/neocotic/html.md/issues/31): Correct expectations of void elements
+* Update versions of dependencies
+
+## Version 2.1.1, 2013.05.06
 
 * [#24](https://github.com/neocotic/html.md/issues/24): Add `base` option to specify the base URL used to resolve relative URLs
 
-2013.05.03, Version 2.1.0
+## Version 2.1.0, 2013.05.03
 
 * [#18](https://github.com/neocotic/html.md/issues/18): Add support for [bower][] installations
 * [#20](https://github.com/neocotic/html.md/issues/20): Replace `Cakefile` with new [grunt][] build process
@@ -19,16 +25,16 @@
 * Replace [optparse][] with [commander][]
 * Lots of bug fixes and optimizations
 
-2013.02.04, Version 2.0.2
+## Version 2.0.2, 2013.02.04
 
 * [#13](https://github.com/neocotic/html.md/issues/13): Add new man page
 * [#14](https://github.com/neocotic/html.md/issues/14): Fix bug with `eval` option
 
-2012.12.12, Version 2.0.1
+## Version 2.0.1, 2012.12.12
 
 * [#8](https://github.com/neocotic/html.md/issues/8): Fix incorrect version
 
-2012.12.11, Version 2.0.0
+## Version 2.0.0, 2012.12.11
 
 * [#1](https://github.com/neocotic/html.md/issues/1): Check inline style attribute to see if elements are hidden
 * [#2](https://github.com/neocotic/html.md/issues/2): Add command line interface

CONTRIBUTING.md

@@ -10,6 +10,7 @@ keeping things right.
   * Clearly describe the issue including steps to reproduce when it is a bug
   * Include the earliest version that you know has the issue
 * Fork the repository on GitHub
+* Read the `INSTALL.md` file
 
 ## Making Changes
 
@@ -23,27 +24,26 @@ keeping things right.
 * Make commits of logical units
 * Check for unnecessary whitespace with `git diff --check` before committing
 * Make sure your commit messages are in the proper format
+* Avoid updating the distributable file or annotated source code documentation
 ```
-    (#99999) Make the example in CONTRIBUTING imperative and concrete
+(#99999) Make the example in CONTRIBUTING imperative and concrete
 
-    Without this patch applied the example commit message in the CONTRIBUTING document is not a
-    concrete example. This is a problem because the contributor is left to imagine what the commit
-    message should look like based on a description rather than an example. This patch fixes the
-    problem by making the example concrete and imperative.
+Without this patch applied the example commit message in the CONTRIBUTING document is not a
+concrete example. This is a problem because the contributor is left to imagine what the commit
+message should look like based on a description rather than an example. This patch fixes the
+problem by making the example concrete and imperative.
 
-    The first line is a real life imperative statement with a ticket number from our issue tracker.
-    The body describes the behavior without the patch, why this is a problem, and how the patch
-    fixes the problem when applied.
+The first line is a real life imperative statement with a ticket number from our issue tracker. The
+body describes the behavior without the patch, why this is a problem, and how the patch fixes the
+problem when applied.
 ```
 * Make sure you have added the necessary tests for your changes
 * Run *all* the tests to assure nothing else was accidentally broken
 
 ## Submitting Changes
 
 * Ensure you added your details to `AUTHORS.md` in the correct format
-```
-    * Joe Bloggs <[email protected]>
-```
+  `Joe Bloggs <[email protected]>`
 * Push your changes to a topic branch in your fork of the repository
 * Submit a pull request to neocotic's repository
 * Update your issue to mark that you have submitted code and are ready for it to be reviewed

Gruntfile.coffee

@@ -8,9 +8,8 @@ module.exports = (grunt) ->
     pkg: grunt.file.readJSON 'package.json'
 
     clean:
-      docs: ['docs/*']
       lib:  ['lib/*']
-      dist: ['dist/*']
+      dist: ['dist/*', 'docs/*']
       test: ['tmp']
 
     coffee:
@@ -45,6 +44,7 @@ module.exports = (grunt) ->
   for dependency of grunt.config.data.pkg.devDependencies when ~dependency.indexOf 'grunt-'
     grunt.loadNpmTasks dependency
 
-  grunt.registerTask 'build',   ['clean', 'coffee', 'docco', 'uglify']
+  grunt.registerTask 'build',   ['clean:lib', 'coffee']
   grunt.registerTask 'default', ['build', 'test']
+  grunt.registerTask 'dist',    ['default', 'clean:dist', 'docco', 'uglify']
   grunt.registerTask 'test',    ['clean:test', 'nodeunit']

INSTALL.md

@@ -1,27 +1,39 @@
-# Build Requirements
+This document is only relevant for those that want to contribute to the [html.md][] open source
+project (we love you guys!). If you are only interested in installing the tool look at `README.md`.
+
+## Build Requirements
+
 In order to build [html.md][], you need to have the following install [git][] 1.7+ and [node.js][]
-0.6+ (which includes [npm][]).
+0.8+ (which includes [npm][]).
+
+## Building
 
-# Building
 Follow these steps to build [html.md][];
 
 1. Clone a copy of the main [html.md git repository](https://github.com/neocotic/html.md) by
    running `git clone git://github.com/neocotic/html.md.git`
 2. `cd` to the repository directory
 3. Ensure you have all of the dependencies by entering `npm install`
 4. Ensure you can run [Grunt][] by running `npm install -g grunt-cli`
-5. For the compiled JavaScript `cd` run `grunt build`
-   * Outputs `md.js` to the `lib` directory
-   * Outputs `md.min.js` (compressed version) to the `dist` directory
-   * Outputs documentation to the `docs` directory
+5. To update the compiled and runnable version enter `grunt build`
+   * Outputs to the `lib` directory
 6. To run the full test suite enter `grunt test`
+   * **Pro Tip:** You can easily run steps 5 and 6 back-to-back by just entering `grunt`
+7. To update the optimized distributable file and documentation enter `grunt dist`
+   * This also compiles and tests all code to ensure the latest code is stable and used
+   * Outputs to distributable file and documentation to the `dist` and `docs` directories
+     respectively
+
+## Important
 
-Simply running `grunt` will cause both the `build` and `test` tasks to be executed, in that order.
-If tests are failing and you require more details, just append `--stack` to the command for a full
-stack trace to be printed out (e.g. `grunt test --stack`).
+If you're planning on contributing to [html.md][] please do **NOT** update the distributable file
+or documentation (step 7) when submitting a pull request. We will not accept pull requests when
+these files have been changed as we do this ourselves when finalizing a release.
+
+Read the `CONTRIBUTING.md` file for more information about submitting pull requests.
 
 [git]: http://git-scm.com
 [grunt]: http://gruntjs.com
+[html.md]: http://neocotic.com/html.md
 [node.js]: http://nodejs.org
 [npm]: http://npmjs.org
-[html.md]: http://neocotic.com/html.md

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (C) 2013 Alasdair Mercer, http://neocotic.com/
+Copyright (C) 2013 Alasdair Mercer, http://neocotic.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  

README.md

@@ -76,17 +76,17 @@ In the terminal:
 
 ``` bash
 # provide HTML to be converted and print it back out to stdout:
-$ md -epi "I <b>love</b> <a href='http://neocotic.com/html.md'>html.md</a>"
+$ html-md -epi "I <b>love</b> <a href='http://neocotic.com/html.md'>html.md</a>"
 I **love** [html.md](http://neocotic.com/html.md)
 # convert HTML files and output them into another directory:
-$ md -o ./markdown ./html/*.html
+$ html-md -o ./markdown ./html/*.html
 # convert all HTML files in the current directory into Markdown files:
-$ md -l .
+$ html-md -l .
 ```
 
 ## Usage
 
-    Usage: md [options] [ -e html | <file ...> ]
+    Usage: html-md [options] [ -e html | <file ...> ]
 
     Options:
 
@@ -164,7 +164,7 @@ This is really just intended for use within a browser.
 The current version of `md`.
 
 ``` javascript
-console.log(md.version); // "2.1.1"
+console.log(md.version); // "3.0.0"
 ```
 
 ## Windows

component.json

@@ -1,5 +1,5 @@
 {
   "name": "html-md",
-  "version": "2.1.1",
+  "version": "3.0.0",
   "main": "dist/md.min.js"
 }