Update docs

README.md

@@ -12,13 +12,7 @@ Add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-oauth1-request = "0.2"
-```
-
-and this to your crate root:
-
-```rust
-extern crate oauth1_request;
+oauth = { version = "0.2", package = "oauth1-request" }
 ```
 
 ## Pros

oauth1-request-derive/src/lib.rs

@@ -3,6 +3,10 @@
 //! This crate provides `#[derive(Authorize)]` macro that implements
 //! `oauth1_request` crate's `Authorize` trait for a struct with named fields.
 //!
+//! `oauth1_request` crate re-exports the derive macro if the `derive` feature of that crate
+//! is enabled (which is on by default).
+//! You should use the re-export instead of depend on this crate directly.
+//!
 //! See [`oauth1_request::Authorize`][Authorize] for more information.
 //!
 //! [Authorize]: https://docs.rs/oauth1-request/0.3/oauth1_request/authorize/trait.Authorize.html

oauth1-request/src/lib.rs

@@ -4,11 +4,19 @@
 //!
 //! # Usage
 //!
+//! Add this to your `Cargo.toml`:
+//!
+//! ```toml
+//! [dependencies]
+//! oauth = { version = "0.2", package = "oauth1-request" }
+//! ```
+//!
+//! For brevity we refer to the crate name as `oauth` throughout the documentation.
+//
 //! ## Create a `GET` request
 //!
 //! ```rust
-//! extern crate oauth1_request as oauth;
-//!
+//! # extern crate oauth1_request as oauth;
 //! #[derive(oauth::Authorize)]
 //! struct SearchComments<'a> {
 //!     article_id: u64,

oauth1-request/src/signer.rs

@@ -16,8 +16,7 @@ use crate::{Options, Request};
 /// Creating a `GET` request:
 ///
 /// ```rust
-/// extern crate oauth1_request as oauth;
-///
+/// # extern crate oauth1_request as oauth;
 /// use oauth::signer;
 ///
 /// let mut sign = signer::HmacSha1Signer::new(

oauth1-request/tests/version_numbers.rs

@@ -1,7 +1,8 @@
-#[test]
-fn test_readme_deps() {
-    version_sync::assert_markdown_deps_updated!("../README.md");
-}
+// Currently `version_sync` does not support renaming crate name with `package` key
+// #[test]
+// fn test_readme_deps() {
+//     version_sync::assert_markdown_deps_updated!("../README.md");
+// }
 
 #[test]
 fn test_html_root_url() {