diff --git a/Cargo.toml b/Cargo.toml index 67008c4..bf84b9c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,6 +2,17 @@ name = "wasi-sol" version = "0.0.1" edition = "2021" +description = "🔒 A Solana Wallet adapter for WASM frameworks." +license = "MIT" +keywords = ["blockchain", "solana", "wallet", "wasm", "yew"] +categories = ["web-programming", "cryptography", "wasm"] +repository = "https://github.com/gigadao/wasi-sol" +documentation = "https://docs.rs/wasi-sol" +authors = [ + "GigaDAO Core Maintainers", + "Mahmoud Harmouch oss@wiseai.dev", +] +exclude = ["examples"] [dependencies] anyhow = "1.0.86" @@ -18,3 +29,16 @@ wasm-bindgen = { version = "0.2.92", features = ["serde-serialize"] } solana-client-wasm = "1.18.0" emitter-rs = "0.0.5" yew = "0.21.0" + +[package.metadata.docs.rs] +all-features = true +rustdoc-args = ["--cfg", "docsrs"] + +[profile.release] +codegen-units = 1 +opt-level = "z" +lto = "thin" +strip = "symbols" + +[badges] +maintenance = { status = "actively-developed" } diff --git a/LICENSE b/LICENSE index e48a5de..2f34cb4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2024 Mahmoud Harmouch +Copyright (c) 2024 GigaDAO Core Maintainers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index b03118c..3521745 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
-# 🦀 wasi-sol +# 🦀 Wasi Sol [![made-with-rust](https://img.shields.io/badge/Made%20with-Rust-1f425f.svg?logo=rust&logoColor=white)](https://www.rust-lang.org/) [![Netlify Status](https://api.netlify.com/api/v1/badges/d7858d73-f54a-4d4f-878f-466168d8ea07/deploy-status)](https://app.netlify.com/sites/wasi-sol/deploys) @@ -54,7 +54,7 @@ A Solana Wallet adapter for WASM frameworks. In addition to the [`examples`](examples) directory, you can use the following snippet of code to add `wasi-sol` wallet adapter using its built-in providers and hooks: -```rust +```rust , ignore use yew::prelude::*; use wasi_sol::{ @@ -180,7 +180,7 @@ fn main() { ## 👥 Contributing -Contributions and feedback are welcome! If you'd like to contribute, report an issue, or suggest an enhancement, please engage with the project on [GitHub](https://github.com/gigadao/wasi-sol). Your contributions help improve this CLI and library for the community. +Contributions and feedback are welcome! If you'd like to contribute, report an issue, or suggest an enhancement, please engage with the project on [GitHub](https://github.com/gigadao/wasi-sol). Your contributions help improve this library for the community. ## 📝 License diff --git a/src/lib.rs b/src/lib.rs index e7fdf54..77244c6 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,6 @@ +#![cfg_attr(docsrs, feature(doc_auto_cfg))] +#![doc = include_str!("../README.md")] + pub mod core; pub mod provider; pub mod solana;