Skip to content

Review: README.md #31

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

Merged
merged 2 commits into from
Oct 12, 2015
Merged

Review: README.md #31

merged 2 commits into from
Oct 12, 2015

Conversation

frankebersoll
Copy link
Contributor

Fixes

  • Changed require('exceptionless.node') to require('exceptionless').

Enhancements

  • Streamlined badges format, added npm badge.
  • Added "Show me the code!" quick start section.
  • Fixed markdown intendation.
  • Replaced "JavaScript" with "Browser" (Node.js is also JavaScript).
  • Refactored last section into "Support" and "Contributing".
  • Some small edits.

@ejsmith
Copy link
Member

ejsmith commented Oct 11, 2015

This looks good to me! @niemyjski?

@niemyjski
Copy link
Member

I had used exceptionless.node because using require('exceptionless') was loading the browser version which uses a umd format. And thus you don't get any of the node code to load. If you can verify that this does in deed work now lets make this change.

@frankebersoll
Copy link
Contributor Author

The documentation assumes that you have downloaded and installed Exceptionless using npm. When you do this, it will install Exceptionless in the node_modules/exceptionless folder, as the node package is named exceptionless. That's how require will find it. The browser version will only be loaded during Excepionless client development, when your root happens to be our git root. Then, you should use require("./dist/exceptionless.node"), but developers will figure this out i hope.

@niemyjski
Copy link
Member

Might want to put that under the developer wiki or read. I guess it goes off of the packages.config for the main script?

@frankebersoll
Copy link
Contributor Author

Just doing this. Yes, it does! Nice writeup how it works: https://nodejs.org/api/modules.html#modules_all_together

I also changed --save-dev to --save, because Exceptionless is not a development dependency but will usually need to ship with the software.

frankebersoll added a commit that referenced this pull request Oct 12, 2015
@frankebersoll frankebersoll merged commit 336ee20 into exceptionless:master Oct 12, 2015
@frankebersoll frankebersoll deleted the docs branch October 12, 2015 13:33
@niemyjski
Copy link
Member

👍

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

Successfully merging this pull request may close these issues.

3 participants