create-ponder 0.16.3 → 0.16.4

package/README.md

@@ -1,11 +1,11 @@
-# Create Ponder
+# create-ponder
 
 [![CI status][ci-badge]][ci-url]
 [![Version][version-badge]][version-url]
 [![Telegram chat][tg-badge]][tg-url]
 [![License][license-badge]][license-url]
 
-Ponder is an open-source framework for blockchain application backends.
+Ponder is an open-source TypeScript framework for EVM data indexing.
 
 ## Documentation
 
@@ -17,47 +17,45 @@ Join [Ponder's telegram chat](https://t.me/pondersh) for support, feedback, and
 
 ## Features
 
-✅ &nbsp;Local development server with hot reloading<br/>
-✅ &nbsp;`create-ponder` CLI tool to get started from an Etherscan link or Graph Protocol subgraph<br/>
-✅ &nbsp;End-to-end type safety using [viem](https://viem.sh) and [ABIType](https://github.com/wagmi-dev/abitype)<br/>
-✅ &nbsp;Autogenerated GraphQL API<br/>
-✅ &nbsp;Easy to deploy anywhere using Node.js/Docker<br/>
-✅ &nbsp;Supports all Ethereum-based blockchains, including test nodes like [Anvil](https://book.getfoundry.sh/anvil)<br/>
-✅ &nbsp;Index events from multiple chains in the same app<br/>
-✅ &nbsp;Reconciles chain reorganization<br/>
-✅ &nbsp;Factory contracts<br/>
-✅ &nbsp;Process transactions calls (in addition to logs)<br/>
-🏗️ &nbsp;Run effects (e.g. send an API request) in indexing code<br/>
+* Index any contract or account on any EVM-compatible chain
+* Write indexed data to Postgres
+* Query indexed data over HTTP using GraphQL or SQL
+* Build rapidly with a powerful local development server
+* Deploy anywhere that runs Node.js or Bun
 
 ## Quickstart
 
 ### 1. Run `create-ponder`
 
-You will be asked for a project name, and if you are using a [template](https://ponder.sh/docs/api-reference/create-ponder#templates) (recommended). Then, the CLI will create a project directory, install dependencies, and initialize a git repository.
+You will be asked for a project name, and if you are using a [template](https://ponder.sh/docs/api-reference/create-ponder#templates) (recommended).
+
+After the prompts, the CLI will create a project directory, install dependencies, and initialize a git repository.
 
 ```bash
-npm init ponder@latest
+bun create ponder
 # or
 pnpm create ponder
 # or
-yarn create ponder
+npm init ponder@latest
 ```
 
 ### 2. Start the development server
 
-Just like Next.js and Vite, Ponder has a development server that automatically reloads when you save changes in any project file. It also prints `console.log` statements and errors encountered while running your code. First, `cd` into your project directory, then start the server.
+Ponder has a development server that automatically reloads when you save changes in any project file. It also prints `console.log` statements and errors encountered while running your code.
+
+First, `cd` into your project directory, then start the server.
 
 ```bash
-npm run dev
+bun dev
 # or
 pnpm dev
 # or
-yarn dev
+npm run dev
 ```
 
-### 3. Add contracts & chains
+### 3. Specify contracts & chains
 
-Ponder fetches event logs for the contracts added to `ponder.config.ts`, and passes those events to the indexing functions you write.
+Ponder fetches event logs for the contracts in `ponder.config.ts`, and passes those events to the indexing functions you write.
 
 ```ts
 // ponder.config.ts
@@ -85,7 +83,7 @@ export default createConfig({
 
 ### 4. Define your schema
 
-The `ponder.schema.ts` file contains the database schema, and defines the shape data that the GraphQL API serves.
+The `ponder.schema.ts` file specifies the database schema, which should match the shape of your application's data model.
 
 ```ts
 // ponder.schema.ts
@@ -101,7 +99,7 @@ export const ensName = onchainTable("ens_name", (t) => ({
 
 ### 5. Write indexing functions
 
-Files in the `src/` directory contain **indexing functions**, which are TypeScript functions that process a contract event. The purpose of these functions is to insert data into the entity store.
+Files in the `src/` directory contain **indexing functions**, which are TypeScript functions that process a contract event. The purpose of these functions is to write indexed data to the database.
 
 ```ts
 // src/BaseRegistrar.ts
@@ -120,11 +118,9 @@ ponder.on("BaseRegistrar:NameRegistered", async ({ event, context }) => {
 });
 ```
 
-See the [create & update records](https://ponder.sh/docs/indexing/write) docs for a detailed guide on writing indexing functions.
-
 ### 6. Query the GraphQL API
 
-Ponder automatically generates a frontend-ready GraphQL API based on your `ponder.schema.ts` file. The API serves data that you inserted in your indexing functions.
+Ponder automatically generates a GraphQL API based on your `ponder.schema.ts` file. The API serves data that you inserted in your indexing functions.
 
 ```ts
 {
@@ -165,12 +161,12 @@ If you're interested in contributing to Ponder, please read the [contribution gu
 
 ## Packages
 
-- `ponder`
-- `@ponder/client`
-- `@ponder/react`
-- `@ponder/utils`
-- `create-ponder`
-- `eslint-config-ponder`
+- [`ponder`](https://www.npmjs.com/package/ponder)
+- [`@ponder/client`](https://www.npmjs.com/package/@ponder/client)
+- [`@ponder/react`](https://www.npmjs.com/package/@ponder/react)
+- [`@ponder/utils`](https://www.npmjs.com/package/@ponder/utils)
+- [`create-ponder`](https://www.npmjs.com/package/create-ponder)
+- [`eslint-config-ponder`](https://www.npmjs.com/package/eslint-config-ponder)
 
 ## About
 

package/dist/index.js

@@ -16,16 +16,19 @@ import { default as prompts } from "prompts";
 // package.json
 var package_default = {
   name: "create-ponder",
-  version: "0.16.3",
+  version: "0.16.4",
   type: "module",
-  description: "A CLI tool to create Ponder apps",
+  description: "CLI tool to create Ponder projects",
   license: "MIT",
   repository: {
     type: "git",
     url: "https://github.com/ponder-sh/ponder",
     directory: "packages/create-ponder"
   },
-  files: ["dist", "templates"],
+  files: [
+    "dist",
+    "templates"
+  ],
   bin: {
     "create-ponder": "./dist/index.js"
   },

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "create-ponder",
-  "version": "0.16.3",
+  "version": "0.16.4",
   "type": "module",
-  "description": "A CLI tool to create Ponder apps",
+  "description": "CLI tool to create Ponder projects",
   "license": "MIT",
   "repository": {
     "type": "git",