blockworks-foundation
/
og-image
mirror of https://github.com/blockworks-foundation/og-image.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Changes to readme (#79) 

* Changes to readme

* Update CONTRIBUTING.md
This commit is contained in:
Steven 2019-04-30 13:07:22 -04:00 committed by GitHub
parent b4f7625a22
commit b19f6c59b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -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!

3
README.md
View File

@ -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.