Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Complexlity committed Aug 11, 2024
1 parent b996c05 commit d4288c5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Uni Farcaster SDK
# UniFarcaster SDK

This is an SDK that combines neynar, airstack to provide a single API without needing to know the underlying apis of both. By default, it should support just passing a hub url and have a default, but in the current implementation, you need either a neynar api key or an airstack api key.

Expand All @@ -23,19 +23,19 @@ const sdkInstance = uniFarcasterSdk({
// Neynar
const sdkInstance = uniFarcasterSdk({
neynarApiKey: 'your-neynar-api-key',
activeService: 'neynar',
activeService: 'neynar'//Optional. It's implied from the api key you provide
})
// Airstack
const sdkInstance = uniFarcasterSdk({
airstackApiKey: 'your-airstack-api-key',
activeService: 'airstack',
activeService: 'airstack' //Optional. It's implied from the api key you provide
})

//Both
const sdkInstance = uniFarcasterSdk({
neynarApiKey: 'your-neynar-api-key',
airstackApiKey: 'your-airstack-api-key',
//You have to specify which service you want to use
//You should specify if you prefer neynar or airstack
activeService: 'neynar',
})

Expand Down

0 comments on commit d4288c5

Please sign in to comment.