Skip to content

docs: miscellaneous README changes#661

Merged
nfischer merged 1 commit intomasterfrom
docs-clean-readme
Mar 4, 2017
Merged

docs: miscellaneous README changes#661
nfischer merged 1 commit intomasterfrom
docs-clean-readme

Conversation

@nfischer
Copy link
Copy Markdown
Member

  • Add @freitagbr to the bottom of the README
  • Remove docs about shjs (it's not well supported)
  • Remove docs about coffeescript (we don't do anything special for
    coffeescript anyway)
  • Modify the section about shelljs/global, since we strongly recommend
    avoiding this now
  • Rewrite the code example to use require('shelljs') instead of
    shelljs/global
  • Mention ESLint next to JSHint
  • Reformat sections with long lines to be 80 columns

README.md Outdated
@@ -1,33 +1,34 @@
# ShellJS - Unix shell commands for Node.js
# ShellJS - Unix shell commands for NodeJS
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should stick with "Node.js", as that is the official name.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Ack, will fix

commands. You can also install it globally so you can run it from outside Node
projects - say goodbye to those gnarly Bash scripts!

ShellJS is proudly tested on every node release since `v0.11`!
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We're only testing on v4 and up now right? Maybe we should change this to v4.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

That hasn't been merged to master branch yet, only dev. And I think that README change already exists in the dev branch.

We could just as well base this PR off dev, instead. No hurry.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ah, right. Let's leave this as v0.11 for now.

## Team

| [![Nate Fischer](https://avatars.githubusercontent.com/u/5801521?s=130)](https://github.com/nfischer) | [![Ari Porad](https://avatars1.githubusercontent.com/u/1817508?v=3&s=130)](http://github.com/ariporad) |
| [![Nate Fischer](https://avatars.githubusercontent.com/u/5801521?s=130)](https://github.com/nfischer) | [![Brandon Freitag](https://avatars1.githubusercontent.com/u/5988055?v=3&s=130)](http://github.com/freitagbr) |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍

@nfischer
Copy link
Copy Markdown
Member Author

@freitagbr PTAL. I changed NodeJS ➡️ Node.js in two places where it appeared.

@freitagbr
Copy link
Copy Markdown
Contributor

One of the "NodeJS" occurrences is in the src/exec.js docs, so it needs to be fixed there too.

 - Add @freitagbr to the bottom of the README
 - Remove docs about shjs (it's not well supported)
 - Remove docs about coffeescript (we don't do anything special for
   coffeescript anyway)
 - Modify the section about shelljs/global, since we strongly recommend
   avoiding this now
 - Rewrite the code example to use `require('shelljs')` instead of
   shelljs/global
 - Mention ESLint next to JSHint
 - Reformat sections with long lines to be 80 columns
@nfischer nfischer force-pushed the docs-clean-readme branch from 830dded to 97ae328 Compare March 4, 2017 08:45
@nfischer
Copy link
Copy Markdown
Member Author

nfischer commented Mar 4, 2017

@freitagbr PTAL. Thanks for catching this

@freitagbr
Copy link
Copy Markdown
Contributor

LGTM 👍

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants