add comment to readme and lib.rs example

Author: Emilgardis

README.md

@@ -22,9 +22,9 @@ use twitch_api::twitch_oauth2::{AccessToken, UserToken};
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
-
+    // Create the HelixClient, which is used to make requests to the Twitch API
     let client: HelixClient<reqwest::Client> = HelixClient::default();
-
+    // Create a UserToken, which is used to authenticate requests
     let token = UserToken::from_token(&client, AccessToken::from("mytoken")).await?;
 
     println!(

examples/eventsub/src/main.rs

@@ -67,7 +67,7 @@ pub async fn run(opts: &Opts) -> eyre::Result<()> {
         .wrap_err_with(|| "when creating client")?,
     );
 
-    // Get the access token
+    // Get the app access token
     let token = twitch_oauth2::AppAccessToken::get_app_access_token(
         &client,
         opts.client_id.clone(),

src/lib.rs

@@ -19,15 +19,13 @@
 //! ```rust,no_run
 //! use twitch_api::helix::HelixClient;
 //! use twitch_api::twitch_oauth2::{AccessToken, UserToken};
-//! pub type BoxedStdError = Box<dyn std::error::Error + Send + Sync + 'static>;
 //!
 //! #[tokio::main]
-//! async fn main() -> Result<(), BoxedStdError> {
+//! async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
+//!     // Create the HelixClient, which is used to make requests to the Twitch API
 //!     let client: HelixClient<reqwest::Client> = HelixClient::default();
-//!
-//!     let token =
-//!         UserToken::from_token(&client, AccessToken::from("mytoken"))
-//!             .await?;
+//!     // Create a UserToken, which is used to authenticate requests.
+//!     let token = UserToken::from_token(&client, AccessToken::from("mytoken")).await?;
 //!
 //!     println!(
 //!         "Channel: {:?}",
@@ -45,10 +43,9 @@
 //!     tokens::errors::AppAccessTokenError, AppAccessToken, TwitchToken,
 //! };
 //! use twitch_api::{helix::channels::GetChannelInformationRequest, TwitchClient};
-//! pub type BoxedStdError = Box<dyn std::error::Error + Send + Sync + 'static>;
 //!
 //! #[tokio::main]
-//! async fn main() -> Result<(), BoxedStdError> {
+//! async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
 //!     let client: TwitchClient<reqwest::Client> = TwitchClient::default();
 //!     let token = AppAccessToken::get_app_access_token(
 //!         &client,