Skip to content

Commit

Permalink
Clean up documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
SeanTAllen committed Feb 8, 2021
1 parent 3ffd37c commit d136e31
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 19 deletions.
22 changes: 4 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,18 @@
# http

Ponylang package to build client and server applications for the HTTP protocol.
Ponylang package to build clients for the HTTP protocol.

## Status

`http` is beta quality software that will change frequently. Expect breaking changes. That said, you should feel comfortable using it in your projects.

### Deprecation

The Server code contained in this repository is considered deprecated. The new official ponylang HTTP Server is hosted at [http_server](https://github.com/ponylang/http_server).

## Installation

* Add `http` (and its transitive dependencies) to your build dependencies using [corral](https://github.com/ponylang/corral):

```bash
corral add github.com/ponylang/http.git

# for testing only
corral add github.com/ponylang/regex.git
corral add github.com/ponylang/net_ssl.git
```

* Execute `corral fetch` to fetch your dependencies.
Expand All @@ -27,14 +21,6 @@ corral add github.com/ponylang/regex.git

Note: The `net-ssl` transitive dependency requires a C SSL library to be installed. Please see the [net-ssl installation instructions](https://github.com/ponylang/net-ssl#installation) for more information.

## History

This is the Pony HTTP/1 library from the standard library, formerly known as `net/http`. It contains both an HTTP client to issue HTTP requests against HTTP servers, and an HTTP server. It also contains a library for handling and parsing URLs.

`http` was removed from the stdlib with [0.24.0](https://github.com/ponylang/ponyc/releases/tag/0.24.0) as a result of [RFC 55](https://github.com/ponylang/rfcs/blob/master/text/0055-remove-http-server-from-stdlib.md). See also [the announcement blog post](https://www.ponylang.io/blog/2018/06/0.24.0-released/).

The Pony Team decided to remove it from the stdlib as it did not meet their quality standards. Given the familiarity of most people with HTTP and thus the attention this library gets, it was considered wiser to remove it from the stdlib and give it a new home as a separate package, where it will not be subject to RFCs in order to rework its innards.

### Help us improve
## API Documentation

It is considered established knowledge that this library needs a complete rework. If you would like to contribute turning this http library into the shape it should be in for representing the power of Ponylang, drop us a note on any of the issues marked as [Help Wanted](https://github.com/ponylang/http/labels/help%20wanted).
[https://ponylang.github.io/http](https://ponylang.github.io/http)
2 changes: 1 addition & 1 deletion corral.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"http"
],
"info": {
"description": "HTTP library",
"description": "HTTP client library",
"homepage": "https://github.com/ponylang/http",
"license": "BSD-2-Clause",
"documentation_url": "https://ponylang.github.io/http/",
Expand Down

0 comments on commit d136e31

Please sign in to comment.