search

exceptionless / Exceptionless.JavaScript

Exceptionless JavaScript client
http://exceptionless.com
Apache License 2.0
59 stars 24 forks source link

Review: README.md #31

Closed frankebersoll closed 8 years ago

frankebersoll commented 8 years ago

Fixes

ejsmith commented 8 years ago

This looks good to me! @niemyjski?

niemyjski commented 8 years ago

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 commented 8 years ago

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 commented 8 years ago

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 commented 8 years ago

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.

niemyjski commented 8 years ago

:+1: