From 871da41f5692d7bab1acddbc9cd215805aad61c2 Mon Sep 17 00:00:00 2001 From: joshua Date: Sat, 27 Oct 2018 22:46:44 +0100 Subject: [PATCH] Update readme --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3a71fe9..8793970 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,23 @@ +# Brief info + +This is the API package for [Bookworm React tutorial](https://github.com/Remchi/bookworm-react). + +The free live-coding series is on [Youtube](https://github.com/Remchi/bookworm-react). + # Setup -Install `mongodb`. In root folder run `yarn`. +Download and install the latest version of [Nodejs](https://nodejs.org/en/download/). + +Downaload and install [Yarn](https://yarnpkg.com/en/docs/install) on your machine. + +Install [mongodb](https://www.mongodb.com/download-center).. + +Clone this project by running the command on your teminal. + + git clone https://github.com/Remchi/bookworm-api.git + +In the root folder run the command in your terminal + + yarn -Rename `env-sample` to `.env` and change it to your liking. \ No newline at end of file +Rename `env-sample` to `.env` and change it to suit your configurations. \ No newline at end of file