chore!: added documentation for root level and signer module

examples/sign_options.rs

@@ -26,8 +26,7 @@ async fn main() {
     Account(account.id().clone())
         .add_key(AccessKeyPermission::FullAccess, ledger_pubkey)
         .with_signer(
-            Signer::new(Signer::seed_phrase(new_seed_phrase, Some("smile".to_string())).unwrap())
-                .unwrap(),
+            Signer::new(Signer::seed_phrase(&new_seed_phrase, Some("smile")).unwrap()).unwrap(),
         )
         .send_to(&network)
         .await

src/lib.rs

@@ -1,3 +1,59 @@
+//! A Rust library for interacting with the NEAR Protocol blockchain
+//!
+//! This crate provides a high-level API for interacting with NEAR Protocol, including:
+//! - Account management and creation
+//! - Contract deployment and interaction
+//! - Token operations (NEAR, FT, NFT)
+//! - Storage management and staking operations
+//! - Custom transaction building and signing
+//! - Several ways to sign the transaction (SecretKey, Seedphrase, File, Ledger, Secure keychain).
+//! - Account nonce caching and access-key pooling mechanisms to speed up the transaction processing.
+//! - Support for backup RPC endpoints
+//!
+//! # Example
+//! ```rust,no_run
+//! use near_api::{*, signer::generate_secret_key};
+//! use std::str::FromStr;
+//!
+//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
+//! // Initialize network configuration
+//! let bob = AccountId::from_str("bob.testnet")?;
+//! let bob_seed_phrase = "lucky barrel fall come bottom can rib join rough around subway cloth ";
+//!
+//! // Fetch NEAR balance
+//! let _bob_balance = Tokens::account(bob.clone())
+//!     .near_balance()
+//!     .fetch_from_testnet()
+//!     .await?;
+//!
+//! // Create an account instance
+//! let signer = Signer::new(Signer::seed_phrase(bob_seed_phrase, None)?)?;
+//! let alice_secret_key = generate_secret_key()?;
+//! Account::create_account(AccountId::from_str("alice.testnet")?)
+//!     .fund_myself(bob.clone(), NearToken::from_near(1))
+//!     .public_key(alice_secret_key.public_key())?
+//!     .with_signer(signer)
+//!     .send_to_testnet()
+//!     .await?;
+//! # Ok(())
+//! # }
+//! ```
+//!
+//! # Features
+//! - `ledger`: Enables hardware wallet support
+//! - `keystore`: Enables system keychain integration
+//! - `workspaces`: Enables integration with near-workspaces for testing
+//!
+//! # Modules
+//! - [`Account`]: Account management and creation
+//! - [`Chain`]: Chain data queries (block, block number)
+//! - [`Contract`]: Contract deployment and interaction
+//! - [`Staking`]: Staking operations
+//! - [`StorageDeposit`]: Storage management and staking operations
+//! - [`Tokens`]: Token operations (NEAR, FT, NFT)
+//! - [`Transaction`]: Custom transaction building and signing
+//! - [`Signer`](`signer`): Signer management and signing
+
 mod account;
 mod chain;
 mod config;