From b19f6c59b9e65bda9b34cfe8aa76674562a258ee Mon Sep 17 00:00:00 2001 From: Steven Date: Tue, 30 Apr 2019 13:07:22 -0400 Subject: [PATCH] Changes to readme (#79) * Changes to readme * Update CONTRIBUTING.md --- CONTRIBUTING.md | 5 ++--- README.md | 3 ++- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 890274023..1fb09b809 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,9 +11,8 @@ To start hacking, do the following: 1. Clone this repo with `git clone https://github.com/zeit/og-image` 2. Change directory with `cd og-image` -2. Run `yarn` or `npm install` to install all dependencies -3. Run `yarn dev` or `npm run dev` to start the dev server -4. Visit http://localhost:8080/public/index.html +3. Run `yarn` or `npm install` to install all dependencies +4. Run locally with `now dev` and visit [localhost:3000](http://localhost:3000) (if nothing happens, run `npm install -g now`) 5. If necessary, edit the `exePath` in [options.ts](https://github.com/zeit/og-image/blob/master/src/options.ts) to point to your local Chrome executable Now you're ready to start local development! diff --git a/README.md b/README.md index 1b760c69a..20f8b573d 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,8 @@ You'll want to fork this repository and deploy your own image generator. 3. Change directory with `cd og-image` 4. Make changes by swapping out images, changing colors, etc (see [contributing](https://github.com/zeit/og-image/blob/master/CONTRIBUTING.md) for more info) 5. Run locally with `now dev` and visit [localhost:3000](http://localhost:3000) (if nothing happens, run `npm install -g now`) -4. Deploy to the cloud by running `now` and you'll get a unique URL +6. Deploy to the cloud by running `now` and you'll get a unique URL +7. Setup [GitHub](https://zeit.co/github) to autodeply on push and set an `alias` in [now.json](https://zeit.co/github) to customize your URL. Alternatively, you can do a one-click to deploy with the button below.