Skip to content

Commit

Permalink
update readme, docs and bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
CherryWorm committed Mar 10, 2022
1 parent 1aad9e7 commit ea4efe4
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 11 deletions.
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# security.txt

[![](https://img.shields.io/crates/v/solana-security-txt)](https://crates.io/crates/solana-security-txt) [![](https://docs.rs/solana-security-txt/badge.svg)](https://docs.rs/solana-security-txt/) [![](https://img.shields.io/crates/v/query-security-txt)](https://crates.io/crates/query-security-txt)

This library defines a macro, whose aim it is to provide easy-to-parse information to security researchers that wish to contact the authors of a Solana smart contract.
It is inspired by https://securitytxt.org/.

Add the following to the `[dependencies]` section of your Cargo.toml:
```toml
security-txt = "0.1.0"
solana-security-txt = "0.1.1"
```

## Example
Expand Down
4 changes: 2 additions & 2 deletions query-security-txt/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "query-security-txt"
version = "0.1.0"
version = "0.1.1"
edition = "2021"
description = "query-security-txt is a tool that queries smart contracts on the Solana blockchain for security.txt information"
readme = "../README.md"
Expand All @@ -11,6 +11,6 @@ license = "MIT OR Apache-2.0"
bincode = "1.3.3"
clap = { version = "3.1.6", features = ["derive"] }
color-eyre = "0.6.1"
solana-security-txt = { version = "0.1.0", path = "../security-txt" }
solana-security-txt = { version = "0.1.1", path = "../security-txt" }
solana-client = "1.10.0"
solana-sdk = "1.10.0"
2 changes: 1 addition & 1 deletion security-txt/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "solana-security-txt"
version = "0.1.0"
version = "0.1.1"
edition = "2021"
description = "security-txt is a macro that helps security researchers contact you about vulnerabilities in your smart contract"
readme = "../README.md"
Expand Down
5 changes: 0 additions & 5 deletions security-txt/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@
//! This library defines a macro, whose aim it is to provide easy-to-parse information to security researchers that wish to contact the authors of a Solana smart contract.
//! It is inspired by https://securitytxt.org/.
//!
//! Add the following to the `[dependencies]` section of your Cargo.toml:
//! ```toml
//! security-txt = "0.1.0"
//! ```
//!
//! ## Example
//! ```rust
//! security_txt! {
Expand Down

0 comments on commit ea4efe4

Please sign in to comment.