search

andywer / postcss-debug

Debug your postcss workflow with ease! Creates snapshots of your CSS files before/after each postcss plugin is run.
MIT License
95 stars 7 forks source link

Better install instructions #4

Open ai opened 8 years ago

ai commented 8 years ago

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

  4. If you use Gulp with gulp-postcss
  5. …
andywer commented 8 years ago

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

ai commented 8 years ago

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).

andywer commented 8 years ago

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.

ai commented 8 years ago

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