Skip to content

Commit

Permalink
Merge pull request #313 from flowonyx/patch-1
Browse files Browse the repository at this point in the history
Fixed some typos in the README.md
  • Loading branch information
elazarl authored Oct 3, 2018
2 parents 947c36d + c42c8c0 commit f58a169
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Package goproxy provides a customizable HTTP proxy library for Go (golang),
It supports regular HTTP proxy, HTTPS through CONNECT, and "hijacking" HTTPS
connection using "Man in the Middle" style attack.

The intent of the proxy, is to be usable with reasonable amount of traffic
yet, customizable and programmable.
The intent of the proxy is to be usable with reasonable amount of traffic,
yet customizable and programmable.

The proxy itself is simply a `net/http` handler.

Expand All @@ -22,7 +22,7 @@ For example, the URL you should use as proxy when running `./bin/basic` is

## Mailing List

New features would be discussed on the [mailing list](https://groups.google.com/forum/#!forum/goproxy-dev)
New features will be discussed on the [mailing list](https://groups.google.com/forum/#!forum/goproxy-dev)
before their development.

## Latest Stable Release
Expand All @@ -32,13 +32,13 @@ Get the latest goproxy from `gopkg.in/elazarl/goproxy.v1`.
# Why not Fiddler2?

Fiddler is an excellent software with similar intent. However, Fiddler is not
as customizable as goproxy intend to be. The main difference is, Fiddler is not
as customizable as goproxy intends to be. The main difference is, Fiddler is not
intended to be used as a real proxy.

A possible use case that suits goproxy but
not Fiddler, is, gathering statistics on page load times for a certain website over a week.
not Fiddler, is gathering statistics on page load times for a certain website over a week.
With goproxy you could ask all your users to set their proxy to a dedicated machine running a
goproxy server. Fiddler is a GUI app not designed to be ran like a server for multiple users.
goproxy server. Fiddler is a GUI app not designed to be run like a server for multiple users.

# A taste of goproxy

Expand Down Expand Up @@ -90,12 +90,12 @@ proxy.OnRequest(goproxy.DstHostIs("www.reddit.com")).DoFunc(
})
```

`DstHostIs` returns a `ReqCondition`, that is a function receiving a `Request` and returning a boolean
we will only process requests that matches the condition. `DstHostIs("www.reddit.com")` will return
`DstHostIs` returns a `ReqCondition`, that is a function receiving a `Request` and returning a boolean.
We will only process requests that match the condition. `DstHostIs("www.reddit.com")` will return
a `ReqCondition` accepting only requests directed to "www.reddit.com".

`DoFunc` will receive a function that will preprocess the request. We can change the request, or
return a response. If the time is between 8:00am and 17:00pm, we will neglect the request, and
return a response. If the time is between 8:00am and 17:00pm, we will reject the request, and
return a precanned text response saying "do not waste your time".

See additional examples in the examples directory.
Expand All @@ -108,14 +108,14 @@ See additional examples in the examples directory.

# License

I put the software temporarily under the Go-compatible BSD license,
if this prevents someone from using the software, do let me know and I'll consider changing it.
I put the software temporarily under the Go-compatible BSD license.
If this prevents someone from using the software, do let me know and I'll consider changing it.

At any rate, user feedback is very important for me, so I'll be delighted to know if you're using this package.

# Beta Software

I've received a positive feedback from a few people who use goproxy in production settings.
I've received positive feedback from a few people who use goproxy in production settings.
I believe it is good enough for usage.

I'll try to keep reasonable backwards compatibility. In case of a major API change,
Expand Down

0 comments on commit f58a169

Please sign in to comment.