From aac11baa99640eafee1cff2b977052bfb202d95b Mon Sep 17 00:00:00 2001 From: Mikkel Laursen Date: Sat, 1 Jan 2022 12:26:26 -0700 Subject: [PATCH] docs: Added documentation for using a GitHub template to bootstrap a new project --- README.md | 3 +++ .../documentation/src/guides/creating-a-new-app.md | 11 +++++++---- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 53f08717cd..c616ca1fbd 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,9 @@ Create an accessible React application with the application - [Creating a new app](https://react-md.dev/guides/creating-a-new-app) - How to create a new app with react-md +- [Using a GitHub template](https://github.com/mlaursen/template-rmd) - Create a + new repo from a GitHub template including reasonable react-md defaults and + Next.js. - [Examples with Build Tools](./examples) - View and download examples of using ReactMD with build tools such as [create-react-app], [Next.js], and [Gatsby] - [Working from v1](https://react-md.dev/guides/working-with-v1) - How to use diff --git a/packages/documentation/src/guides/creating-a-new-app.md b/packages/documentation/src/guides/creating-a-new-app.md index 092b7df898..50188078de 100644 --- a/packages/documentation/src/guides/creating-a-new-app.md +++ b/packages/documentation/src/guides/creating-a-new-app.md @@ -4,13 +4,16 @@ This guide will help you create a new app with `react-md` along with [create-react-app] as the project bootstrapper. The basic requirements for continuing are: -- [node] installed with at least version `10` to make things simple +- [node] installed with at least version `14` to make things simple - [yarn] or [npm] - experience in React -> You can also check out the -> [GitHub examples folder]({{GITHUB_URL}}/tree/main/examples) to see completed -> examples and other build tools such as [Next.js](https://nextjs.org/). +> If you want to get started immediately, you can view the +> [GitHub examples folder]({{GITHUB_URL}}/tree/main/examples) which outlines +> quick ways to spin up a new project with different build tools. Another +> alternative is using the +> [react-md GitHub template](https://github.com/mlaursen/template-rmd) to +> bootstrap a new repo with Next.js and some reasonable defaults. ## Bootstrapping a new Project