Skip to content

Conversation

nfischer
Copy link
Member

If you have any formatting issues with the example in the README, or want the example changed, feel free to modify as you see fit.

I haven't tested this example, but I'm pretty sure it's correct. Feel free to test it out.

@levithomason
Copy link
Contributor

Looks good, I'll test it soon as I can. While we're at cleanup, would you mind aligning the comments as well? I think it helps with scanning readability.

$ shx pwd                        # ShellJS commands are supported automatically
/home/username/path/to/dir

$ shx ls                         # files are outputted one per line
file.txt
file2.txt

$ shx rm *.txt                   # a cross-platform way to delete files!

$ shx ls

$ shx echo "Hi there!"
Hi there!

$ shx touch helloworld.txt

$ shx cp helloworld.txt foobar.txt

$ shx mkdir sub

$ shx ls
foobar.txt
helloworld.txt
sub

$ shx rm -r sub                  # options work as well

@nfischer
Copy link
Member Author

Good suggestion, will do

@nfischer
Copy link
Member Author

@levithomason Updated with your suggestion

@levithomason
Copy link
Contributor

Haven't tested but it looks like it should work as described. LGTM

@nfischer
Copy link
Member Author

Alright, I'll merge this in. If there's any issues, we can revise that in another PR.

@nfischer nfischer merged commit f327389 into master Apr 23, 2016
@levithomason levithomason deleted the docs-readme branch April 23, 2016 04:19
file2.txt

$ shx rm *.txt # a cross-platform way to delete files!

$ shx ls
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shoudl we delete this too?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left it to demonstrate that files are deleted, as expected.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. You might want to add a comment describing that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants