From f842e04a094019ead6f84c8e43fa8acd0727ba7b Mon Sep 17 00:00:00 2001 From: Rob Cameron Date: Mon, 11 Jan 2021 15:02:38 -0800 Subject: [PATCH] Update README --- README.md | 26 ++++---------------------- 1 file changed, 4 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 69cbc06..14796ab 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,6 @@ -# Redwood +# Redwood Tutorial App -> **WARNING:** RedwoodJS software has not reached a stable version 1.0 and should not be considered suitable for production use. In the "make it work; make it right; make it fast" paradigm, Redwood is in the later stages of the "make it work" phase. +This repo represents the final state of the app created during the [Redwood Tutorial](https://redwoodjs.com/tutorial). +It is meant to be a starting point for those working on the [Tutorial Part 2](https://redwoodjs.com/tutorial2). -## Getting Started -- [Tutorial](https://redwoodjs.com/tutorial/welcome-to-redwood): getting started and complete overview guide. -- [Docs](https://redwoodjs.com/docs/introduction): using the Redwood Router, handling assets and files, list of command-line tools, and more. -- [Redwood Community](https://community.redwoodjs.com): get help, share tips and tricks, and collaborate on everything about RedwoodJS. - -### Setup - -We use Yarn as our package manager. To get the dependencies installed, just do this in the root directory: - -```terminal -yarn install -``` - -### Fire it up - -```terminal -yarn redwood dev -``` - -Your browser should open automatically to `http://localhost:8910` to see the web app. Lambda functions run on `http://localhost:8911` and are also proxied to `http://localhost:8910/.redwood/functions/*`. +This repo contains much more styling than the one we built together in the tutorial, but is functionally identical.