Skip to content

Update README #10

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

Closed
adammcarth wants to merge 3 commits into from
Closed

Update README #10

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
255f9ca
Update README
adammcarth Nov 6, 2014
4e98ab1
Reference CONTRIBUTE.md in contribution guidelines
adammcarth Nov 7, 2014
3690936
Fix broken link
adammcarth Nov 7, 2014
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
21 changes: 13 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,15 @@ packages first. Proxygen, fbthrift, and folly are all autotools based projects.

Directory structure and contents:

* `proxygen/external/` Contains non-installed 3rd-party code proxygen depends on.
* `proxygen/lib/` Core networking abstractions.
* `proxygen/lib/http/` HTTP specific code.
* `proxygen/lib/services/` Connection management and server code.
* `proxygen/lib/ssl/` TLS abstractions and OpenSSL wrappers.
* `proxygen/lib/utils/` Miscellaneous helper code.
* `proxygen/httpserver/` Contains code wrapping `proxygen/lib/` for building simple C++ http servers. We recommend building on top of these APIs.
| Directory | Purpose |
|----------------------------|-------------------------------------------------------------------------------|
| `proxygen/external/` | Contains non-installed 3rd-party code proxygen depends on. |
| `proxygen/lib/` | Core networking abstractions. |
| `proxygen/lib/http/` | HTTP specific code. |
| `proxygen/lib/services/` | Connection management and server code. |
| `proxygen/lib/ssl/` | LS abstractions and OpenSSL wrappers. |
| `proxygen/lib/utils/` | Miscellaneous helper code. |
| `proxygen/httpserver/` | Contains code wrapping `proxygen/lib/` for building simple C++ http servers. We recommend building on top of these APIs. |

### Architecture

Expand All @@ -66,7 +68,7 @@ it a transaction identifier. The codec then calls into `HTTPSession` which
is responsible for maintaining the mapping between transaction identifier
and `HTTPTransaction` objects. Each HTTP request/response pair has a
separate `HTTPTransaction` object. Finally, `HTTPTransaction` forwards the
call to a handler object which implements `HTTPTransation::Handler`. The
call to a handler object which implements `HTTPTransaction::Handler`. The
handler is responsible for implementing business logic for the request or
response.

Expand Down Expand Up @@ -134,6 +136,9 @@ copy of these docs by running `doxygen Doxyfile` from the project
root. You'll want to look at `html/namespaceproxygen.html` to start. This
will also generate folly and thrift documentation.

### Contributing
Contribututions to Proxygen are more than welcome. [Read the guidelines in CONTRIBUTING.md](CONTRIBUTING.md). Make sure you've [signed the CLA](https://code.facebook.com/cla) before sending in a pull request!

### Whitehat

Facebook has a [bounty program](https://www.facebook.com/whitehat/) for
Expand Down