From 1542c53dce358d9b05c94cc43f7193b86008c03c Mon Sep 17 00:00:00 2001 From: Hippo Date: Thu, 19 Dec 2019 19:23:41 +0530 Subject: [PATCH] Update README --- README.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7bf581d..3ad3c5b 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,33 @@ -![Gridsome starter casper preview](https://i.imgur.com/TmJcF77.png?1) +This is the source code for the upcoming [Snipette](https://beta.snipettemag.com) +website, build with [Ghost](https://ghost.org) and [Gridsome](https://gridsome.org/) +and using a customised version of Ghost's [casper](https://demo.ghost.io/) +theme. -This starter is a [casper](https://demo.ghost.io/) based theme built using [Gridsome](https://gridsome.org/). +This project is based on [Yashu Mittal](https://gitlab.com/mittalyashu)'s +**[Gridsome Starter Casper](https://gitlab.com/mittalyashu/gridsome-starter-casper)** +project and adapted to pull data via Ghost's API instead of through Markdown +files. We'll be updating it to suit our needs, but feel free to clone it +for your own use. (Just use your own posts instead of copying ours 😉) ## Deploy To deploy the website, click the deploy button. -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://gitlab.com/mittalyashu/gridsome-starter-casper) +[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://gitlab.com/snipettemag/gridsome-ghost-site) + +You will have to set the `GHOST_API_URL` and `GHOST_CONTENT_KEY` environment +variables. Alternatively, copy the contents of `sample-env` to a file +named `.env` (or `.env.development` or `.env.production`) and replace +the sample values with values from your own Ghost installation. ## Donate -I've put a lot of time and effort into making **Gridsome Starter Casper** project. If you love it, you can Become a Patron. I promise it will be a good investment 😉. +This project relies heavily on the original **[Gridsome Starter Casper](https://gitlab.com/mittalyashu/gridsome-starter-casper)** +project. If you like it, you can support development of that project by +using the button below: -[![Become a Patron](https://i.imgur.com/wYOr44L.png)](https://www.patreon.com/bePatron?u=8494594) \ No newline at end of file +[![Become a Patron](https://i.imgur.com/wYOr44L.png)](https://www.patreon.com/bePatron?u=8494594) + +If you like Snipette and want to support the magazine itself, please +check out our [Liberapay profile](https://liberapay.com/snipette) or +contact us through social media for more!