Skip to content

improved docs #136

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
san0808 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

improved docs #136

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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Squash: A squarish bug spray
Squash: A epic way to remove bugs
============================

**An open-source project from [Square](http://github.com/square)**
Expand All @@ -9,11 +9,11 @@ Squash consists of the following components:

* **Client libraries:** Client libraries for different systems (Ruby, Ruby on
Rails, Cocoa with Objective-C, etc.) catch and record errors when they occur,
then send them to the API endpoint. Client libraries can be found under the
then send them to the API end point. Client libraries can be found under the
[SquareSquash organization](https://github.com/SquareSquash).
* **Front-end:** This website displays Bug information and helps the engineer
* **Front-end:** This website displays Bug info and helps the engineer
find the root cause for a Bug, and fix it. It also lets engineers manage,
assign, and comment on Bugs, as well as view statistics about the Bug.
assign and comment on Bugs as well as view statistics about the Bug.
* **API endpoints:** These routes (part of the front-end app) receive exception
notifications from the client libraries and process them.

Expand Down