docs: add example project instructions

alex-grover · Sep 26, 2023 · d1d7021 · d1d7021
1 parent aab9ab5
commit d1d7021
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -16,6 +16,18 @@ This repo is a work in progress, use at your own risk! Currently, the following
 
 ## Installation
 
+### Quick Start
+
+To quickly scaffold a project with a simple feed and cast posting functionality:
+
+```shell
+npx degit alex-grover/neynar-next/example my-farcaster-app
+```
+
+All you need to do is add your FID, Farcaster mnemonic, and Neynar API key to the project's .env and you'll be up and running!
+
+### Manual Installation
+
 ```sh
 npm install neynar-next viem
 ```

diff --git a/example/README.md b/example/README.md
@@ -5,5 +5,7 @@ This is a simple Farcaster client intended to get you up and running with neynar
 ## Getting Started
 
 ```shell
-npx degit alex-grover/neynar-next/example
+npx degit alex-grover/neynar-next/example my-farcaster-app
 ```
+
+All you need to do is add your FID, Farcaster mnemonic, and Neynar API key to the project's .env and you'll be up and running!