search

gruntjs / grunt-contrib-connect

Start a static web server.
http://gruntjs.com
MIT License
714 stars 146 forks source link

Getting started is misleading. #182

Open danielrob opened 9 years ago

danielrob commented 9 years ago

For those new to grunt, the getting started section of the main README is incomplete, only assuming and implying the user will know to register the task, after making it available through loadNpmTaks() call.

When, in my case, just the load didn't work (I didn't expect it to), and I saw there was no simplest case obvious example in the rest of the document, I tried an empty config object connect: {}, which failed, so I did a quick google search got some bogus configuration which apparently doesn't do anything as it still starts on the default port 8000. But at least it starts: 

    connect: {
      example: {
        port: 8080,
        base: './'
      }
    },

It would make it much faster and friendlier to developers to provide the minimal possible sensible task configuration in the getting started section (especially as the 'Options' are not optional you apparently need to specify something to actually make the task run)?
(Versions: grunt-cli v0.1.13, grunt v0.4.5)

XhmikosR commented 6 years ago

You can always submit a PR to improve the docs.