Skip to content

Commit

Permalink
Add lots of README files
Browse files Browse the repository at this point in the history
  • Loading branch information
alexcrichton committed Aug 9, 2016
1 parent 9426059 commit 83fc6b7
Show file tree
Hide file tree
Showing 7 changed files with 193 additions and 3 deletions.
36 changes: 36 additions & 0 deletions futures-cpupool/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# futures-cpupool

A library for creating futures representing work happening concurrently on a
dedicated thread pool.

[![Build Status](https://travis-ci.org/alexcrichton/futures-rs.svg?branch=master)](https://travis-ci.org/alexcrichton/futures-rs)
[![Build status](https://ci.appveyor.com/api/projects/status/yl5w3ittk4kggfsh?svg=true)](https://ci.appveyor.com/project/alexcrichton/futures-rs)

[Documentation](http://alexcrichton.com/futures-rs/futures_cpupool)

## Usage

First, add this to your `Cargo.toml`:

```toml
[dependencies]
futures = { git = "https://github.com/alexcrichton/futures-rs" }
futures-cpupool = { git = "https://github.com/alexcrichton/futures-rs" }
```

Next, add this to your crate:

```rust
extern crate futures;
extern crate futures_cpupool;

use futures_cpupool::CpuPool;
```

# License

`futures-cpupool` is primarily distributed under the terms of both the MIT
license and the Apache License (Version 2.0), with portions covered by various
BSD-like licenses.

See LICENSE-APACHE, and LICENSE-MIT for details.
34 changes: 34 additions & 0 deletions futures-io/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# futures-io

A library for `Future` and `Stream` based abstractions for working with I/O
objects.

[![Build Status](https://travis-ci.org/alexcrichton/futures-rs.svg?branch=master)](https://travis-ci.org/alexcrichton/futures-rs)
[![Build status](https://ci.appveyor.com/api/projects/status/yl5w3ittk4kggfsh?svg=true)](https://ci.appveyor.com/project/alexcrichton/futures-rs)

[Documentation](http://alexcrichton.com/futures-rs/futures_io)

## Usage

First, add this to your `Cargo.toml`:

```toml
[dependencies]
futures = { git = "https://github.com/alexcrichton/futures-rs" }
futures-io = { git = "https://github.com/alexcrichton/futures-rs" }
```

Next, add this to your crate:

```rust
extern crate futures;
extern crate futures_io;
```

# License

`futures-io` is primarily distributed under the terms of both the MIT license
and the Apache License (Version 2.0), with portions covered by various BSD-like
licenses.

See LICENSE-APACHE, and LICENSE-MIT for details.
33 changes: 33 additions & 0 deletions futures-iobuf/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# futures-iobuf

A work-in-progress library for an I/O buffer abstraction.

[![Build Status](https://travis-ci.org/alexcrichton/futures-rs.svg?branch=master)](https://travis-ci.org/alexcrichton/futures-rs)
[![Build status](https://ci.appveyor.com/api/projects/status/yl5w3ittk4kggfsh?svg=true)](https://ci.appveyor.com/project/alexcrichton/futures-rs)

[Documentation](http://alexcrichton.com/futures-rs/futures_iobuf)

## Usage

First, add this to your `Cargo.toml`:

```toml
[dependencies]
futures = { git = "https://github.com/alexcrichton/futures-rs" }
futures-iobuf = { git = "https://github.com/alexcrichton/futures-rs" }
```

Next, add this to your crate:

```rust
extern crate futures;
extern crate futures_iobuf;
```

# License

`futures-iobuf` is primarily distributed under the terms of both the MIT license
and the Apache License (Version 2.0), with portions covered by various BSD-like
licenses.

See LICENSE-APACHE, and LICENSE-MIT for details.
14 changes: 14 additions & 0 deletions futures-minihttp/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# futures-minihttp

This library is a proof-of-concept implementation of an HTTP server using
futures.

[![Build Status](https://travis-ci.org/alexcrichton/futures-rs.svg?branch=master)](https://travis-ci.org/alexcrichton/futures-rs)
[![Build status](https://ci.appveyor.com/api/projects/status/yl5w3ittk4kggfsh?svg=true)](https://ci.appveyor.com/project/alexcrichton/futures-rs)

This crate is an implementation of a vastly simplified version of a "server
framework" to showcase the performance of futures when applied with HTTP. This
is not intended to be a production-ready HTTP framework, but rather just a demo
Expand Down Expand Up @@ -67,3 +73,11 @@ singlethread no pipeline column it was 1.
Also note that iron/hyper currently have a bug with pipelining, explaining the
N/A, and I couldn't figure out how to get rapidoid to run on one thread,
explaining that N/A.

# License

`futures-minihttp` is primarily distributed under the terms of both the MIT
license and the Apache License (Version 2.0), with portions covered by various
BSD-like licenses.

See LICENSE-APACHE, and LICENSE-MIT for details.
15 changes: 12 additions & 3 deletions futures-mio/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# futures-mio

Build status, license, and other information can be found in the top-level
[README.md].
Bindings to the `mio` crate implementing the `futures-io` and `futures`
abstractions.

[README.md]: https://github.com/alexcrichton/futures-rs#futures-rs
[![Build Status](https://travis-ci.org/alexcrichton/futures-rs.svg?branch=master)](https://travis-ci.org/alexcrichton/futures-rs)
[![Build status](https://ci.appveyor.com/api/projects/status/yl5w3ittk4kggfsh?svg=true)](https://ci.appveyor.com/project/alexcrichton/futures-rs)

[Documentation](http://alexcrichton.com/futures-rs/futures_mio)

Expand Down Expand Up @@ -61,3 +62,11 @@ combinators to compose working with data on sockets.
Check out the [documentation] for more information, and more coming here soon!

[documentation]: http://alexcrichton.com/futures-rs/futures_mio

# License

`futures-mio` is primarily distributed under the terms of both the MIT license
and the Apache License (Version 2.0), with portions covered by various BSD-like
licenses.

See LICENSE-APACHE, and LICENSE-MIT for details.
32 changes: 32 additions & 0 deletions futures-socks5/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# futures-socks5

An implementation of a SOCKSv5 proxy server built on top of `futures-mio`.

[![Build Status](https://travis-ci.org/alexcrichton/futures-rs.svg?branch=master)](https://travis-ci.org/alexcrichton/futures-rs)
[![Build status](https://ci.appveyor.com/api/projects/status/yl5w3ittk4kggfsh?svg=true)](https://ci.appveyor.com/project/alexcrichton/futures-rs)

## Usage

First, run the server

```
$ cargo run
...
Listening for socks5 proxy connections on 127.0.0.1:8080
```

Then in a separate window you can test out the proxy:

```
$ export https_proxy=socks5h://localhost:8080
$ curl -v https://www.google.com
```

# License

`futures-socks5` is primarily distributed under the terms of both the MIT
license and the Apache License (Version 2.0), with portions covered by various
BSD-like licenses.

See LICENSE-APACHE, and LICENSE-MIT for details.

32 changes: 32 additions & 0 deletions futures-tls/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# futures-tls

An implementation of TLS/SSL streams built on top of the `futures-io` crate.

[![Build Status](https://travis-ci.org/alexcrichton/futures-rs.svg?branch=master)](https://travis-ci.org/alexcrichton/futures-rs)
[![Build status](https://ci.appveyor.com/api/projects/status/yl5w3ittk4kggfsh?svg=true)](https://ci.appveyor.com/project/alexcrichton/futures-rs)

[Documentation](http://alexcrichton.com/futures-rs/futures_tls)

## Usage

First, add this to your `Cargo.toml`:

```toml
[dependencies]
futures-tls = { git = "https://github.com/alexcrichton/futures-rs" }
```

Next, add this to your crate:

```rust
extern crate futures_tls;
```

# License

`futures-tls` is primarily distributed under the terms of both the MIT license
and the Apache License (Version 2.0), with portions covered by various BSD-like
licenses.

See LICENSE-APACHE, and LICENSE-MIT for details.

0 comments on commit 83fc6b7

Please sign in to comment.