-
Notifications
You must be signed in to change notification settings - Fork 51
docs: update example in README #32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
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 |
Good suggestion, will do |
@levithomason Updated with your suggestion |
Haven't tested but it looks like it should work as described. LGTM |
Alright, I'll merge this in. If there's any issues, we can revise that in another PR. |
file2.txt | ||
|
||
$ shx rm *.txt # a cross-platform way to delete files! | ||
|
||
$ shx ls |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
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.