Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
felipeog committed Feb 22, 2023
1 parent b7bc2f0 commit af590ca
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 4 deletions.
20 changes: 17 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# #boraCodar

## Resources

- [#boraCodar](https://boracodar.dev)
- [@rocketseat - Figma](https://www.figma.com/@rocketseat)

## Challenges

| Name | Code | Preview |
Expand All @@ -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 <workspace_name> <command>
```
14 changes: 14 additions & 0 deletions scripts/generateReadme/consts/readmeSections.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 <workspace_name> <command>\n` +
"```\n",
};
3 changes: 2 additions & 1 deletion scripts/generateReadme/utils/getReadmeContent.js
Original file line number Diff line number Diff line change
Expand Up @@ -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");

Expand Down

0 comments on commit af590ca

Please sign in to comment.