postcss-debug icon indicating copy to clipboard operation
postcss-debug copied to clipboard

Better install instructions

Open ai opened this issue 9 years ago • 4 comments

You current instructions is good. But we could do better :).

People will use your tool, then they have some problem in existed build tool. So, they already use some tool: grunt-postcss, gulp-postcss, postcss-loader or postcss-cli.

You should give a install instructions in this way:

postcss-cli

  1. If you have postcss-cli
  2. Install postcss-debug
  3. Replace postcss-cli to postcss-debug in you scrips.

gulp-postcss

  1. If you use Gulp with gulp-postcss

ai avatar May 25 '16 19:05 ai

@ai Would you say it's ok for now as it is? (Added a little more documentation yesterday)

andywer avatar May 31 '16 21:05 andywer

Better. But best way will be just a diff — ”replace this to this” (sorry, that I only write bad things, I am Russian we always only talk only about bad things, you do great work, really fast development).

ai avatar May 31 '16 21:05 ai

No problem, since it's constructive. I just think it's hard to provide a diff, since PostCSS can be used in so many different ways and setups. And there is some chance people will prefer using the CLI for debugging instead of changing the build process, anyway, I guess.

I re-edited the gulp-postcss example slightly to make it more clear what to change, though.

andywer avatar May 31 '16 21:05 andywer

Yeap, but we can provide diff for easy and popular cases and have API for other cases :)

ai avatar May 31 '16 23:05 ai