From 982ac7d87451a6353e9fbe2df949a53cedc2e362 Mon Sep 17 00:00:00 2001 From: Eric Jinks Date: Fri, 1 Jun 2018 15:36:18 +1000 Subject: [PATCH] Update Readme --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e066ec5..5d1d5a1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# 🌶 Netlify CMS + React Starter +# Netlify CMS + React Starter [![Standard - JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) @@ -18,18 +18,18 @@ I aim to include commonly used components and best-practices e.g. forms, setting [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/Jinksi/netlify-cms-react-starter) -1. Hit the **Deploy to Netlify** button. This will: +1. Hit the **Deploy to Netlify** button. This will: * Clone the repo into your Github account * Create you a new project on Netlify, build & deploy -1. Once your Netlify project has been created, change a couple of settings: +1. Once your Netlify project has been created, change a couple of settings: * Enable **Identity** * Change **Registration Preferences** to **Invite Only** * Enable **Git Gateway** -1. Invite users (probably yourself) to enable admin access +1. Invite users (probably yourself) to enable admin access * Open the **Identity** tab and hit **Invite Users** @@ -39,21 +39,21 @@ The CMS lives at [\_\_YOUR_SITE_NAME\_\_.netlify.com/admin](https://__YOUR_SITE_ ## Developing -1. Clone your repo to your local machine +1. Clone your repo to your local machine -1. Install dependencies +1. Install dependencies `yarn` or `npm install` -1. Run the development server +1. Run the development server `yarn start` or `npm run start` If you are adding or editing content locally in the CMS, a couple of things to note: -1. Changes will be pushed to the remote repo. +1. Changes will be pushed to the remote repo. -1. You will be prompted to enter your site's url, this is necessary for Netlify Identity to manage user login. This is stored in `localStorage`, so you might have to empty your browser cache if you are switching projects but remaining on `localhost:3000`. +1. You will be prompted to enter your site's url, this is necessary for Netlify Identity to manage user login. This is stored in `localStorage`, so you might have to empty your browser cache if you are switching projects but remaining on `localhost:3000`. ## Editing CMS fields