From af590cabf47b9421b879e90d668848310ce981bb Mon Sep 17 00:00:00 2001 From: felipeog <17603069+felipeog@users.noreply.github.com> Date: Wed, 22 Feb 2023 01:20:10 -0300 Subject: [PATCH] Update readme --- readme.md | 20 ++++++++++++++++--- .../generateReadme/consts/readmeSections.js | 14 +++++++++++++ .../generateReadme/utils/getReadmeContent.js | 3 ++- 3 files changed, 33 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index c7b61ec..3861a3d 100644 --- a/readme.md +++ b/readme.md @@ -1,5 +1,10 @@ # #boraCodar +## Resources + +- [#boraCodar](https://boracodar.dev) +- [@rocketseat - Figma](https://www.figma.com/@rocketseat) + ## Challenges | Name | Code | Preview | @@ -12,7 +17,16 @@ | 06-boarding-pass | [Open code](https://github.com/felipeog/bora-codar/tree/main/challenges/06-boarding-pass) | [Open preview](https://fog-bc-boarding-pass.netlify.app) | | 07-carnival | [Open code](https://github.com/felipeog/bora-codar/tree/main/challenges/07-carnival) | [Open preview](https://fog-bc-carnival.netlify.app) | -## Resources +## Workspaces -- [#boraCodar](https://boracodar.dev) -- [@rocketseat - Figma](https://www.figma.com/@rocketseat) +Defining workspaces: + +``` +yarn plop +``` + +Running commands in the context of workspaces: + +``` +yarn workspace +``` diff --git a/scripts/generateReadme/consts/readmeSections.js b/scripts/generateReadme/consts/readmeSections.js index d243d27..ed5faeb 100644 --- a/scripts/generateReadme/consts/readmeSections.js +++ b/scripts/generateReadme/consts/readmeSections.js @@ -5,4 +5,18 @@ export const readmeSections = { `\n` + `- [#boraCodar](https://boracodar.dev)\n` + `- [@rocketseat - Figma](https://www.figma.com/@rocketseat)\n`, + workspaces: + `## Workspaces\n` + + `\n` + + `Defining workspaces:\n` + + `\n` + + "```\n" + + `yarn plop\n` + + "```\n" + + `\n` + + `Running commands in the context of workspaces:\n` + + `\n` + + "```\n" + + `yarn workspace \n` + + "```\n", }; diff --git a/scripts/generateReadme/utils/getReadmeContent.js b/scripts/generateReadme/utils/getReadmeContent.js index e2d6a83..f1e9e92 100644 --- a/scripts/generateReadme/utils/getReadmeContent.js +++ b/scripts/generateReadme/utils/getReadmeContent.js @@ -6,8 +6,9 @@ export function getReadmeContent(challenges) { const challengesSection = formatChallengeSection(challenges); const orderedSections = [ readmeSections.header, - challengesSection, readmeSections.resources, + challengesSection, + readmeSections.workspaces, ]; const content = orderedSections.join("\n");