Add library and usage information to main API doc.

This commit is contained in:
Sergio Benitez 2016-10-02 17:52:04 -07:00
parent 7c78994b70
commit 39c979db4c
1 changed files with 44 additions and 2 deletions

View File

@ -1,7 +1,7 @@
#![feature(question_mark)] #![feature(question_mark)]
#![feature(specialization)] #![feature(specialization)]
//! # Rocket //! # Rocket - Core API Documentation
//! //!
//! Hello, and welcome to the core Rocket API documentation! //! Hello, and welcome to the core Rocket API documentation!
//! //!
@ -15,7 +15,49 @@
//! You may also be interested in looking at the [contrib API //! You may also be interested in looking at the [contrib API
//! documentation](../rocket_contrib), which contains JSON and templating //! documentation](../rocket_contrib), which contains JSON and templating
//! support. //! support.
//!
//! ## Libraries
//!
//! Rocket's functionality is split into three crates:
//!
//! 1. [Core](/rocket) - The core library. Needed by every Rocket application.
//! 2. [Codegen](/rocket_codegen) - Core code generation plugin. Should always
//! be used alongsize `rocket`, though it's not necessary.
//! 3. [Contrib](/rocket_contrib) - Provides useful functionality for many
//! Rocket application. Completely optional.
//!
//! ## Usage
//!
//! The sanctioned way to use Rocket is via the code generation plugin. This
//! makes Rocket easier to use and allows a somewhat stable API as Rust matures.
//! To use Rocket in your Cargo-based project, add the following to
//! `Cargo.toml`:
//!
//! ```rust,ignore
//! [dependencies]
//! rocket = "*"
//! rocket_codegen = "*"
//! ```
//!
//! If you'll be deploying your project to Crates.io, you'll need to change the
//! "*" to the current version of Rocket.
//!
//! Then, add the following to top of your `main.rs` file:
//!
//! ```rust,ignore
//! #![feature(plugin)]
//! #![plugin(rocket_codegen)]
//!
//! extern crate rocket;
//! ```
//!
//! See the [guide](https://guide.rocket.rs) for more information on how to
//! write Rocket application.
//!
//! ## Configuration
//!
//! Rocket is configured via the `Rocket.toml` file.
//!
extern crate term_painter; extern crate term_painter;
extern crate hyper; extern crate hyper;
extern crate url; extern crate url;