Skip to content

Commit

Permalink
Changes to readme (vercel#79)
Browse files Browse the repository at this point in the history
* Changes to readme

* Update CONTRIBUTING.md
  • Loading branch information
styfle authored Apr 30, 2019
1 parent b4f7625 commit b19f6c5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
5 changes: 2 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit b19f6c5

Please sign in to comment.