farcaster-rs

🚀 A simple & easy way to interface with Farcaster via Rust 🦀

Author: Landon Boles

GitHub

|

Farcaster

|

Bird App

📜 Documentation

For extensive documentation, visit our docs.rs page

Otherwise, check out the docs folder for examples on how to use functions from each method.

🚀 Getting Started

Installation

To get started, add the farcaster_rs crate to your Cargo.toml file

toml farcaster_rs = "0.1.0-pre.6"

Once you have the crate installed, you can start using the crate!

Usage

In your main.rs file, set up a new Farcaster struct using the ::new(client: String) method.

```rust use farcaster_rs::Farcaster;

[tokio::main]

async fn main() { let farcaster = Farcaster::new("https://goerli.infura.io/v3/key".to_string());

let landon = farcaster.get_user_by_username("lndnnft".to_string()).await.unwrap();

println!("{:#?}", landon);

} ```

🙏 Contributing

To start, I appreciate any and all contributions to the farcaster-rs repository!

There are 3 prefered things I'd like if you decide to contribute, however.

1. Ensure the issue/contribution is needed

If you spend your time building something, please ensure it's actually wanted/needed, this is best done by using the Issues tab, and either viewing other discussions, or opening a new issue/discussion

2. Create a new branch for your contribution

Once you have validated the contribution, and forked the repo to your own GitHub account, please create a new branch to commit your code onto.

This can be done via the git CLI pretty easily:

sh $ git switch -c my_cool_feature

3. Create a detailed pull request, with documentation

I'd like to keep everything documented to make it as easy as possible for people looking to use the crate.

When opening a pull request, please ensure your function/contribution has been properly documented, and include good information about it in the PR. (use common sense)

Thanks so much!