Browse Source

Update 'README.md'

天问 2 years ago
parent
commit
080fe77c55
1 changed files with 33 additions and 1 deletions
  1. 33 1
      README.md

+ 33 - 1
README.md

@@ -1,2 +1,34 @@
-# scribble-diffusion
+# 🖍️ Scribble Diffusion
+
+Try it out at [scribblediffusion.com](https://scribblediffusion.com)
+
+## How it works
+
+This app is powered by:
+
+🚀 [Replicate](https://replicate.com/?utm_source=project&utm_campaign=scribblediffusion), a platform for running machine learning models in the cloud.
+
+🖍️ [ControlNet](https://replicate.com/rossjillian/controlnet?utm_source=project&utm_campaign=scribblediffusion), an open-source machine learning model that generates images from text and scribbles.
+
+▲ [Vercel](https://vercel.com/), a platform for running web apps.
+
+⚡️ Next.js [server-side API routes](pages/api), for talking to the Replicate API.
+
+👀 Next.js React components, for the browser UI.
+
+🍃 [Tailwind CSS](https://tailwindcss.com/), for styles.
+
+## Development
+
+1. Install a recent version of [Node.js](https://nodejs.org/)
+1. Copy your [Replicate API token](https://replicate.com/account?utm_source=project&utm_campaign=scribblediffusion) and set it in your environment:
+   ```
+   echo "REPLICATE_API_TOKEN=<your-token-here>" > .env.local
+   ```
+1. Install dependencies and run the server:
+   ```
+   npm install
+   npm run dev
+   ```
+1. Open [localhost:3000](http://localhost:3000) in your browser. That's it!