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

Update README.md (#117)

This commit is contained in:
Steven 2020-05-26 12:00:21 -04:00 committed by GitHub
parent 3406121c3a
commit ceef73898b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -32,9 +32,7 @@ It looks like the following:
## Why use this service?
Read the [blog post](https://vercel.com/blog/social-og-image-cards-as-a-service) for more info on the "Why" part.
The short answer is that it would take a long time to painstakingly design an image for every single blog post. And we don't want the exact same image for every blog post because that wouldn't make the article stand out when it was shared to Twitter.
The short answer is that it would take a long time to painstakingly design an image for every single blog post and every single documentation page. And we don't want the exact same image for every blog post because that wouldn't make the article stand out when it was shared to Twitter.
That's where `og-image.now.sh` comes in. We can simply pass the title of our blog post to our generator service and it will generate the image for us on the fly!
@ -57,25 +55,15 @@ You'll want to fork this repository and deploy your own image generator.
2. Clone the repo to your local machine with `git clone URL_OF_FORKED_REPO_HERE`
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`)
6. Deploy to the cloud by running `now` and you'll get a unique URL
7. Setup [GitHub](https://vercel.com/github) to autodeploy on push
5. Hobby plan users will need to remove all configuration inside `now.json` besides `rewrites`
6. Run locally with `now dev` and visit [localhost:3000](http://localhost:3000) (if nothing happens, run `npm install -g now`)
7. Deploy to the cloud by running `now` and you'll get a unique URL
8. Setup [GitHub](https://vercel.com/github) to autodeploy on push
Alternatively, you can do a one-click to deploy with the button below.
If you are using a paid plan, you can do a one-click deploy with the button below.
[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/new/project?template=zeit/og-image)
If you are using the Hobby plan, you will need to remove all configuration inside `now.json` besides
`rewrites`. Your `now.json` should look like this:
```json
{
"rewrites": [
{ "source": "/(.+)", "destination": "/api" }
]
}
```
Once you have an image generator that sparks joy, you can setup [automatic GitHub](https://vercel.com/github) deployments so that pushing to master will deploy to production! 🚀
## Authors