Skip to content

Commit

Permalink
Simplify README and add ToC to module doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ramosbugs committed Dec 8, 2019
1 parent 368c616 commit 34aaa9f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 40 deletions.
42 changes: 3 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,7 @@
<a href="https://crates.io/crates/oauth2"><img src="https://img.shields.io/crates/v/oauth2.svg"></a>
<a href="https://travis-ci.org/ramosbugs/oauth2-rs"><img src="https://travis-ci.org/ramosbugs/oauth2-rs.svg?branch=master"></a>

A simple implementation of the OAuth2 flow in Rust.
An extensible, strongly-typed implementation of OAuth2
([RFC 6749](https://tools.ietf.org/html/rfc6749)).

Documentation is available on [docs.rs](https://docs.rs/oauth2) or check the [examples](https://github.com/ramosbugs/oauth2-rs/tree/master/examples).

Before upgrading make sure to check out the [changelog](https://github.com/ramosbugs/oauth2-rs/releases).

### Contributed Examples

- [`actix-web-oauth2`](https://github.com/pka/actix-web-oauth2) (version 2.x of this crate)

## Development

Build:

```
cargo build
```

using futures 0.3:
this requires at least rust 1.39.0
```
cargo build --no-default-features --features "futures-03"
```

Run tests:

```
cargo test
```

using futures 0.3:
```
cargo test --no-default-features --features "futures-03"
```

Release:

```
cargo package && cargo publish
```
Documentation is available on [docs.rs](https://docs.rs/oauth2). Release notes are available on [GitHub](https://github.com/ramosbugs/oauth2-rs/releases).
17 changes: 16 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@
//! An extensible, strongly-typed implementation of OAuth2
//! ([RFC 6749](https://tools.ietf.org/html/rfc6749)).
//!
//! # Contents
//! * [Importing `oauth2`: selecting an HTTP client interface](#importing-oauth2-selecting-an-http-client-interface)
//! * [Getting started: Authorization Code Grant w/ PKCE](#getting-started-authorization-code-grant-w-pkce)
//! * [Example: Synchronous (blocking) API](#example-synchronous-blocking-api)
//! * [Example: Asynchronous (futures 0.1-based) API](#example-asynchronous-futures-01-based-api)
//! * [Example: Async/Await API](#example-asyncawait-api)
//! * [Implicit Grant](#implicit-grant)
//! * [Resource Owner Password Credentials Grant](#resource-owner-password-credentials-grant)
//! * [Client Credentials Grant](#client-credentials-grant)
//! * [Other examples](#other-examples)
//! * [Contributed Examples](#contributed-examples)
//!
//! # Importing `oauth2`: selecting an HTTP client interface
//!
//! This library offers a flexible HTTP client interface with three modes:
Expand Down Expand Up @@ -463,7 +475,10 @@
//! - [Microsoft Graph](https://github.com/ramosbugs/oauth2-rs/blob/master/examples/msgraph.rs)
//! - [Wunderlist](https://github.com/ramosbugs/oauth2-rs/blob/master/examples/wunderlist.rs)
//!
//! ## Contributed Examples
//!
//! - [`actix-web-oauth2`](https://github.com/pka/actix-web-oauth2) (version 2.x of this crate)
//!
use std::borrow::Cow;
use std::fmt::Error as FormatterError;
use std::fmt::{Debug, Display, Formatter};
Expand Down

0 comments on commit 34aaa9f

Please sign in to comment.