formatting

README.md

@@ -11,24 +11,51 @@ Check out [this Neynar docs page](https://docs.neynar.com/docs/create-farcaster-
 ## Getting Started
 
 To create a new mini app project, run:
+
 ```{bash}
 npx @neynar/create-farcaster-mini-app@latest
 ```
 
 To run the project:
+
 ```{bash}
 cd <PROJECT_NAME>
 npm run dev
 ```
 
+## Code Formatting & Linting
+
+This template includes comprehensive formatting and linting tools to ensure consistent code quality:
+
+- **Prettier**: Automatic code formatting
+- **ESLint**: Code linting with Next.js and TypeScript support
+- **EditorConfig**: Cross-editor consistency
+
+### Available Scripts
+
+```bash
+npm run format        # Format all files with Prettier
+npm run format:check  # Check if files are properly formatted
+npm run lint          # Run ESLint
+npm run lint:fix      # Fix ESLint issues automatically
+npm run type-check    # Run TypeScript type checking
+npm run check         # Run all checks (types, lint, format)
+```
+
+See [FORMATTING.md](./FORMATTING.md) for detailed configuration and setup information.
+
 ### Importing the CLI
+
 To invoke the CLI directly in JavaScript, add the npm package to your project and use the following import statement:
+
 ```{javascript}
 import { init } from '@neynar/create-farcaster-mini-app';
 ```
 
 ## Deploying to Vercel
+
 For projects that have made minimal changes to the quickstart template, deploy to vercel by running:
+
 ```{bash}
 npm run deploy:vercel
 ```
@@ -36,6 +63,7 @@ npm run deploy:vercel
 ## Building for Production
 
 To create a production build, run:
+
 ```{bash}
 npm run build
 ```
@@ -51,11 +79,12 @@ This section is only for working on the script and template. If you simply want
 To iterate on the CLI and test changes in a generated app without publishing to npm:
 
 1. In your installer/template repo (this repo), run:
+
    ```bash
    npm link
    ```
-   This makes your local version globally available as a symlinked package.
 
+   This makes your local version globally available as a symlinked package.
 
 1. Now, when you run:
    ```bash
@@ -76,4 +105,3 @@ However, this does not fully replicate the npx install flow and may not catch al
 ### Environment Variables and Scripts
 
 If you update environment variable handling, remember to replicate any changes in the `dev`, `build`, and `deploy` scripts as needed. The `build` and `deploy` scripts may need further updates and are less critical for most development workflows.
-