Skip to content

Removed grammatical errors. #15

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Removed grammatical errors. #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 11 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ documentation at https://github.com/SquareSquash/web.

### JavaScript client

Documentation is written in Codo format. HTML documentation can be generated by
Documentation is written in the Codo format. HTML documentation can be generated by
running `rake doc:js`. Note that Codo is still a work in progress, and the
generated docs will have some formatting errors. The documentation is written to
the `doc/js` directory.
Expand All @@ -22,7 +22,7 @@ install with `rake setup`.

### Ruby library

Markdown-formatted YARD documentation is available by running `rake doc:ruby`.
Markdown-formatted YARD documentation is available by running `rake doc: ruby`.
The documentation is written to the `doc/ruby` directory.

Compatibility
Expand All @@ -38,16 +38,15 @@ Requirements
------------

The JavaScript library uses TraceKit for cross-platform stack trace extraction.
The library is included in this project. For Rails projects, a Sprockets include
The library is included in this project. For Rails projects, a Sprockets have
file is provided. For non-Rails projects, the output of `rake minify` rolls in
the library.

**The included version of TraceKit has been modified somewhat:**

* `window.onerror` support was expanded to include changes in recent versions of
modern browsers (namely, passing the column and error object as parameters).
* TraceKit was causing unexpected behavior on Chrome and Firefox, and parts of
it are commented out. (The jQuery hooks were disabled.)
* TraceKit was causing unexpected behavior on Chrome and Firefox, and parts of it are commented out. (The jQuery hooks were disabled.)

Installation
------------
Expand All @@ -67,12 +66,12 @@ JavaScript into your application.js file (or other JavaScript manifest):
For other projects, you may need to compile the CoffeeScript file first. If you
do not have the `coffee` binary installed in your path, you can download and
install a copy of CoffeeScript by running `rake setup`. This task uses npm (the
Node package manager) to perform the installation; you will need to install npm
Node package manager) to perform the installation, you will need to install npm
first if you haven't already. CoffeeScript will be installed into a
project-local directory.

Once you have the `coffee` binary, you can run `rake minify` to generate a
JavaScript file that you can use in your project. If you would like a
The javaScript file that you can use in your project. If you would like a
non-minified JavaScript file without dependencies, run `rake compile`.

Place the compiled `squash_javascript.min.js` file in a Web-public directory and
Expand All @@ -87,11 +86,11 @@ The file defines a `SquashJavascript` singleton which is accessible using

### Configuring CORS

In order for applications to report their JavaScript errors to Squash, your
For applications to report their JavaScript errors to Squash, your
Squash instance must be configured to accept cross-origin requests from your
other website. In your Squash web code, update the `allowed_origins`
another website. In your Squash web code, update the `allowed_origins.`
configuration (under `config/environments/[environment]/dogfood.yml`) to include
the host serving your application.
the host is serving your application.

Usage
-----
Expand Down Expand Up @@ -122,7 +121,7 @@ Features** below.

### Additional Features

There are a number of other features you can take advantage of to help you debug
There are several other features you can take advantage of to help you debug
your exceptions:

#### User Data
Expand Down Expand Up @@ -256,7 +255,7 @@ API endpoint is pre-configured, though you can always set your own (see
Failsafe Reporting
------------------

In the event that the Squash client itself raises an exception when processing
If the Squash client itself raises an exception when processing
an exception, it will log that exception to the console. Both the original
exception and the failsafe error will be logged. The original exception will
still be re-raised, but the failsafe error will be "eaten."
Expand Down