From 20a36049ff2d03d6a4e06e57f346770d8150fc9f Mon Sep 17 00:00:00 2001 From: marcoandre1 Date: Mon, 7 Dec 2020 00:28:21 -0500 Subject: [PATCH] Update README --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a60afb..97ec11d 100644 --- a/README.md +++ b/README.md @@ -1 +1,10 @@ -This is a starter template for [Learn Next.js](https://nextjs.org/learn). +# Next.js Blog + +**Demo Website** : [modokemdev.com/nextjs-blog](https://modokemdev.com/nextjs-blog/) + +This repository was built following the [Learn Next.js](https://nextjs.org/learn) tutorial. It is a [Next.js](https://nextjs.org/) blog app deployed to [GitHub Pages](https://pages.github.com/) using [gh-pages](https://www.npmjs.com/package/gh-pages). We are rendering the data at build time, including the `md` files for each post. + +You can find in [Releases](https://github.com/marcoandre1/nextjs-blog/releases) a starter template configured to deploy directly to GitHub Pages. + +> To run this project locally, clone the project and run `npm run dev`. +> To deploy, update `next.config.js` file and from `git bash` run `npm run export` followed by `npm run deploy`.