From d4288c50ad34f88b3e726f25a66218ff1b33d22b Mon Sep 17 00:00:00 2001 From: Complexlity Date: Sun, 11 Aug 2024 22:36:14 +0100 Subject: [PATCH] docs: update readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b4e8e63..fd2f8d7 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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', })