-
Notifications
You must be signed in to change notification settings - Fork 744
Edit the docs to emphasize ShellStrings and Pipes #398
Description
The introduction of ShellStrings is a pretty big change, since a lot of people rely on the old behavior of strings have the .to() method (here's an example from our friends over at dthree/cash).
We might want to consider adding that back in to the String.prototype for now, and give a deprecation warning, since this might be a big impediment to users migrating to the new version. Or, if we decide to keep it as-is, we should document it a bit more clearly, and make it obvious for how people can create a file with the syntax:
ShellString('some text').to('file.txt');Also, I think pipes are one of the more useful features in ShellJS v0.7, so these should probably be advertised better in the docs.
On a related note, it might be worth starting guides in the wiki pages about how to migrate from version to version. We've been introducing quite a few breaking changes, so it might ease the transition for users to have these breaking changes highlighted (and not only buried in the changelog with all the features/bug fixes/etc.).