diff --git a/.env.sample b/.env.sample index 6fd53fc..af9bd52 100644 --- a/.env.sample +++ b/.env.sample @@ -1,13 +1,13 @@ -# Hub to download messages from +# (optional) Default Hub to download messages from NEXT_PUBLIC_HUB_REST_URL="https://nemes.farcaster.xyz:2281" -# Will only fetch a subset of messages if "development" +# (optional) Will only fetch a subset of messages if "development" NEXT_PUBLIC_NODE_ENV="development" # WalletConnect project ID for connecting wallets (https://cloud.walletconnect.com) NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID= -# Developer FID and mnemonic for counter-signing new signer key requests +# (optional) Developer FID and mnemonic for counter-signing new signer key requests FARCASTER_DEVELOPER_FID= FARCASTER_DEVELOPER_MNEMONIC= diff --git a/README.md b/README.md index c403366..62d2f09 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,17 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +# Farcaster Signer Tools -## Getting Started +This app helps you manage your Farcaster signers. Features include: -First, run the development server: +- View apps that have signers for your account +- Backup messages for signers +- Consolidate messages for signers for a single app +- Delete signers +- Create local signers to migrate to (stored in browser `localStorage`) +- Migrate backup archives to a new local signer -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +## Development -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +1. Clone the repo +2. Copy the `.env.sample` file to `.env` and fill in the values +3. Run `npm run dev` +4. Open your browser to `http://localhost:3000`