diff --git a/README.md b/README.md index c403366..19a7fd2 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,21 @@ +# MTG Visual Search + +Web utility to search Magic: The Gathering cards by artwork contents. Uses card data and images from the [Scryfall API](https://scryfall.com/docs/api). Relies on caption data generated by [mtg-chair-ai](https://git.hobbs.zone/henry/mtg-chair-ai). + 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). ## Getting Started -First, run the development server: +See [mtg-chair-ai](https://git.hobbs.zone/henry/mtg-chair-ai) for instructions on generating caption data. Data should by placed in the root directory as `data.json`. + +Install dependencies: + +```bash +npm install +``` + +Run the development server: ```bash npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev ``` - -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.