From 315ac6fc0aa5a8a87c555ae44708401c59c468dd Mon Sep 17 00:00:00 2001 From: Joff Tiquez Date: Sat, 13 May 2023 13:43:32 +0800 Subject: [PATCH] docs(README.md): minor grammar updates Generally, the previous grammar are totally acceptable, except for some very minor slip-up. --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 940267e8da..88e46e9714 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ The decision was made to allow faster iterations and to keep features parity in ### eslint-config -Shared settings for eslint for all the projects in this repo. +Shared ESLint settings for all the projects in this repo. ### extension @@ -42,16 +42,15 @@ The browser extension project. Includes webpack configuration for browser extens ### prettier-config -Shared settings for prettier for all the projects in this repo. +Shared Prettier settings for all the projects in this repo. ### shared -The main project with most of the components that are used in the applications. Every component that need to be used in both platforms should be placed in this project. This includes the design system components, custom hooks, and many more. +The main project contains most of the components used in the applications. Every component that needs to be used on both platforms should be placed in this project. This includes the design system components, custom hooks, and many more. ### webapp -The web app project. It is a Next.js project and it has more pages than the extension. Such as registration page, post page, profile page, etc. -For more information [click here](https://github.com/dailydotdev/apps/tree/master/packages/webapp). +The web app project. This is a Next.js project and has more pages than the extension, such as a registration page, post page, profile page, etc. For more information [click here](https://github.com/dailydotdev/apps/tree/master/packages/webapp). ## Local Environment @@ -63,13 +62,15 @@ We have a GitPod button above, click on it and let's roll! So you want to contribute to daily.dev app suite and make an impact, we are glad to hear it. :heart_eyes: Before you proceed we have a few guidelines for contribution that will make everything much easier. + We would appreciate if you dedicate the time and read them carefully: https://github.com/dailydotdev/.github/blob/master/CONTRIBUTING.md ## Bootstrap Project After cloning the project, please make sure to run the following commands to bootstrap the project: -``` + +```bash npm i -g lerna lerna bootstrap ```