Merge pull request #606 from jenius/readme

Add clarity to sourceMap option

Merge pull request #606 from jenius/readme
Add clarity to sourceMap option
520dd86a · Adeel Mujahid · a11fafdc · d97ca3e9 · 520dd86a
Commit 520dd86a authored Jan 07, 2015 by Adeel Mujahid
Hide whitespace changes
Inline Side-by-side

Showing with 2 additions and 2 deletions

README.md README.md +2 -2

No files found.
--- a/README.md
+++ b/README.md
-# node-sass
+# node-sass

 <table>
  <tr>
@@ -118,7 +118,7 @@ The callback function is passed a results object, containing the following keys:
 `sourceComments` is a `Boolean` flag to determine what debug information is included in the output file.

 #### sourceMap
-`sourceMap` can be set as `String` or `Boolean`. If it is set to `true`, the path of sourceMap would be computed by node-sass w.r.t the outFile path. It can also be set to absolute or relative (to outFile) path.
+You must define this option as well as `outFile` in order to generate a source map. If it is set to `true`, the source map will be generated at the path provided in the `outFile` option. If set to a path (`String`), the source map will be generated at the provided path.

 #### sourceMapEmbed
 `sourceMapEmbed` is a `Boolean` flag to determine whether to embed `sourceMappingUrl` as data URI.